README Generator
Generate a README that answers what, why, and how-to-run in 60 seconds.
Creates a complete, honest README from your project details: what it does, quickstart that actually works, configuration table, and project status. Optimized for the 60-second scan a real visitor gives your repo before deciding to use it or leave.
The prompt
Variables to fill in: {{details}}
Write a README.md for the project below. A visitor should understand what it does and have it running within 60 seconds of reading.
Structure:
1. One-sentence description (what + who it's for). Then 2-3 sentences on why it exists (what it replaces or fixes).
2. **Quickstart** — the minimal copy-pasteable commands to install and run. Include prerequisites with versions.
3. **Usage** — 1-2 realistic examples with expected output shown.
4. **Configuration** — table of env vars/options: Name | Default | Description. Only if applicable.
5. **Project status** — honest: production / beta / experiment / unmaintained.
6. **Contributing & License** — one line each.
Rules: no badges wall, no marketing language, no "blazingly fast." If I haven't given you enough for a section, put [TODO: what's needed] rather than inventing details. Code blocks must be complete and runnable, not elided with "...".
Project details:
{{details}}Try it out
Open in Playground →Run this prompt on a real model without leaving the page. Every run is saved to your history for this prompt.
Fill in the variables
How to use
- 1Paste as much as you have into {{details}}: the package.json/pyproject, main entry file, or even just a description of what it does.
- 2Fill the [TODO] markers it leaves — those are real gaps, not laziness.
- 3Actually run the quickstart commands in a clean environment before committing; the model can't verify your install works.
Examples
CLI tool README
Input
Details: a Go CLI that converts Notion exports to Hugo markdown, installed via `go install`, two flags: --input and --out.
Output
# notion2hugo Convert Notion workspace exports into Hugo-ready markdown, for people migrating their blog off Notion. ## Quickstart ```bash go install github.com/[TODO: your path]/notion2hugo@latest notion2hugo --input export.zip --out content/posts ```...
Pro tips
- Regenerate the Usage section whenever your CLI flags change — stale examples are worse than none.
Frequently asked questions
Can it document an existing codebase it hasn't seen?+
Give it the entry point file and directory listing and it does well. For anything bigger, use a coding agent with repo access (see the claude-md library on this site) rather than a single prompt.