한국어
☰ Categories

Write a repository README

Gets a newcomer running within ten minutes by putting execution ahead of feature description.

CategoryDevelopment › Technical writing
TagsDraftingTemplateDeveloper
Prompt
Write a README for this project.

Order, strictly:
1. **One sentence: what this is and who it is for.** Not a tagline.
2. **Quickstart** — the shortest path from clone to something working. Exact commands. *If this takes more than about ten minutes or five commands, say so and say why; that is the finding.*
3. What you should see when it worked.
4. Prerequisites, but only the ones that actually block. Move the rest down.
5. Common failures during setup, with the fix. Every project has two or three and they are almost never written down.
6. Configuration — only what must be set. Defaults stay in a table further down.
7. How to run the tests.
8. Everything else — architecture, contributing, license.

Rules:
- *Commands must be copy-pasteable.* Where a value has to be supplied, say where to obtain it.
- Do not open with badges, a logo, or a feature list. Someone reading this wants it running.
- **Where I did not tell you how something works, write `TODO:` with the specific question** rather than a plausible instruction. A wrong setup step costs more than a missing one.
- State what this project does *not* do, if there is an obvious adjacent thing people will assume.
After pasting, fill in the fields at the bottom (Project · How to run it · Who reads it)

What this prompt does

What a README needs is not an introduction but how to run it. This leads with the shortest path to a working state and documents where people get stuck.

More in this category

Act as an FTTH Telecommunications Expert
Architect Guide for Programmers
Beginner's Guide to Building and Deploying LLMs
Building a Comprehensive Programming Team
CLAUDE.md Assembly