Craft stunning, professional GitHub README files in minutes.
Powered by AI, synchronized via Cloud, and built for developers.
Generate high-quality project descriptions and feature lists using Google Gemini AI. Improve your grammar and tone with a single click.
Never lose your work. With Firebase integration, your projects and custom snippets are synchronized across Web, Desktop, and Mobile seamlessly.
Build your documentation visually. Choose from a library of 20+ professional components including:
- Dynamic Widgets: Spotify status, YouTube cards, and GitHub activity graphs.
- Advanced Graphics: Mermaid.js diagrams and automatic Table of Contents.
- Developer Tools: GitHub stats, contributors' grids, and social badges.
Point to a local folder or a public GitHub URL. Our system scans your codebase structure and uses AI to "reverse engineer" a comprehensive README for you.
A sleek, modern interface built with Glassmorphism and a Slate-Blue palette. Optimized for high performance even on lower-end devices.
Access the latest stable version directly in your browser:
👉 Launch App Now
- Go to the Releases page.
- Download the
readme_creator_windows.zip. - Extract and run
readme_creator.exe.
Download the latest APK from the releases and install it on your device to create documentation on the go.
To change the Android applicationId, set appApplicationId in gradle.properties (project root) or pass it at build time:
appApplicationId=com.example.readmecreator./gradlew assembleRelease -PappApplicationId=com.example.readmecreator- Framework: Flutter (Multi-platform UI)
- Backend: Firebase (Auth, Firestore, Analytics)
- AI Engine: Google Generative AI (Gemini 1.5 Flash)
- State Management: Provider
- Styling: Google Fonts (Inter & Poppins)
We love open source! Whether you're fixing bugs, adding new elements, or improving the AI prompts, your contributions are welcome.
Please read our CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
- Security: See SECURITY.md for reporting vulnerabilities.
- Support: Check SUPPORT.md for getting help.
This project is licensed under the MIT License - see the LICENSE file for details.