Write a README People Finish
Most READMEs are either empty or too long. This prompt writes the four parts people actually read, from a few facts you give it.
Works with Claude, ChatGPT and Gemini4 fieldsSaves as README.md
Write a README.md for csvkit-lite. A small CLI that converts CSV files to JSON and back. Install: pip install csvkit-lite Example: ``` csvlite to-json data.csv > data.json ``` Sections, in this order: one-paragraph intro, Install, Quick example (with expected output), Options (only if I gave any), Getting help, License placeholder. Plain language, no badges, no marketing words. Do not invent features, options or output that I did not give you; leave a TODO instead.
Everything you type stays in your browser. Remove passwords, keys and personal data before pasting anything into an AI tool.
Why this prompt is written this way
- Four parts that matter. Intro, install, an example and help answer what a new user needs.
- No invented features. A README that promises options that don't exist costs you issues and trust.
- Expected output. Showing what the example prints lets people check it worked.
Example answer
Illustrative and shortened, to show the shape of a good answer. Real answers vary by model.
# csvkit-lite Convert CSV files to JSON and back from the command line. ## Install pip install csvkit-lite ## Quick example csvlite to-json data.csv > data.json
Tips
- Paste the --help output of your CLI to get an accurate Options section.
- Keep the first screen short; move details to docs.
How to use it
- Replace the example values with your own. The prompt on the right updates as you type.
- Press Copy prompt and paste it into any AI chat, or open it straight in Claude or ChatGPT.
- Save it as README.md if you want to reuse it or keep it in your repository.