Describe the project
Give the project name, a one- or two-sentence purpose, key directories, install/run/test/build commands, and required configuration.
README DRAFT
README Draft Generator
Turn your repository's purpose, structure, commands, and configuration into a public-facing README.md draft.
- Uses your inputs in a transparent calculation
- Instant result with practical next steps
- No signup required
Planning guidance only. Validate important decisions with customer evidence and your delivery team.
YOUR INPUTS
Build your result
Complete every field. The result updates only when you choose Calculate.
How it works
Get an assembled README.md
The tool assembles a real markdown draft — title, description, table of contents, getting started commands, project structure, a configuration table, and standard sections — from exactly what you entered.
Copy, fill gaps, and commit
Copy the markdown into README.md, fill in the placeholder descriptions, add a license, and commit it to the repository.
Continue learning: AI tools in an MVP development workflow · Source code and IP rules for AI development tools
Frequently asked questions
How is this different from the Repository Context Summarizer?
The Repository Context Summarizer produces a compact internal handoff document meant for an AI coding assistant. This tool produces an actual public-facing README.md draft meant for humans browsing your repository.
Does it write the whole README for me?
It assembles the structure and fills in what you provide — commands, structure, configuration — but placeholder text remains where you have not given detail, such as per-directory descriptions and license choice. Treat it as a strong first draft, not a finished document.
Will it read my actual repository files?
No. It only uses the text you type or paste into the form. It does not connect to GitHub, read your file system, or call any external API.
Can I use this for an existing project with a README already?
Yes. Paste your current structure and commands to regenerate a consistently formatted draft, then merge in any project-specific sections your current README already has.
Should I include secrets or real environment variable values?
No. List variable names only (e.g. DATABASE_URL, API_KEY) — never paste actual secret values into the configuration field or the generated README.
What license does it add?
None automatically. It adds a placeholder License section for you to fill in, since license choice depends on your project and should be a deliberate decision.
How We Compare
| Feature | MVPHub | readme.so | GitHub Copilot |
|---|---|---|---|
| Generated from your actual project details | Included | Limited | Limited |
| Includes a configuration variables table | Included | Not included | Limited |
| No account or editor plugin required | Included | Included | Not included |
| Free to use | Included | Included | Limited |
readme.so provides a visual template editor you fill in manually section by section. GitHub Copilot can draft README content inline in an editor but needs repository context and an active subscription. MVPHub instantly assembles a structured draft from a short form, no editor or account required.
Related tools
Embed this tool
Add this tool to your site with the canonical iframe below. It remains hosted and maintained by MVPHub.