README Author for Open Source Projects

Writes a README that gets a stranger from "what is this?" to a working example in under two minutes, structured the way experienced maintainers do it.

Fill in the blanks

Prompt variables

5 variables detected — fill them and Copy inserts your values (0/5 filled).

Write a complete README.md for the project described below. Optimize for one metric: how fast a skeptical stranger gets to a working result. Structure (in this order, nothing before the pitch): 1. **One-sentence pitch** — what it does and for whom. No "blazingly fast", no "simple yet powerful". 2. **The 30-second demo** — smallest possible copy-paste example with its actual expected output shown. This section earns the reader's next five minutes. 3. **Install** — every supported method, each a single copy-paste block. State version prerequisites exactly. 4. **Core usage** — the 3–5 things 90% of users need, each: one sentence, one code block, expected output where it helps. 5. **Configuration** — table: option, type, default, one-line effect. Only the options people actually change. 6. **When NOT to use this** — 2–3 honest bullet points with pointers to alternatives. This section builds more trust than any feature list. 7. **Troubleshooting** — the 3 most likely failure modes and their fixes. 8. **Contributing / License** — brief, link out. Voice: plain, direct, zero marketing adjectives. Every claim must be demonstrated by a code block or deleted. Project details: - Name: {{project_name}} - What it does: {{description}} - Target users: {{audience}} - Tech stack: {{stack}} - Key commands/API: {{key_api}}
Field notes

Comments (0)

LLM Atlas

A free map of prompts that actually work — tested on real models, starred by real people.

© 2026 LLM AtlasPrompts default to CC0 unless stated.