Why this prompt works
This readme prompt is built around the question every new developer asks first: how do I get this running? The quick start comes right after the one-line description, with copy-paste commands, because a README that buries setup under background makes people give up.
"Only use commands I gave you" stops the AI from inventing install steps or scripts that do not exist, a common problem with AI-written docs. The configuration table with example values, and the rule against real secrets, keeps setup clear without leaking anything sensitive.
How to use this prompt
- Tap "Copy prompt".
- Replace every part in [square brackets] with your own details.
- Paste it into ChatGPT or Claude and send.
- Ask a follow-up like "make it shorter" or "give me 3 more options" to fine-tune it.
Variations to try
Docstrings for a module
- Type
- Text
- Fill in
- 3 blanks
- Copies
- Be the first
Architecture overview for the team
- Type
- Text
- Fill in
- 2 blanks
- Copies
- Be the first
Changelog from commits
- Type
- Text
- Fill in
- 2 blanks
- Copies
- Be the first
Make it your own
- Add a "Screenshots" or "Demo" section if your project has a UI.
- Ask for badges such as build status and licence at the top if your repository uses CI.
- Ask for a shorter README plus a separate CONTRIBUTING.md for larger projects.
Common problems and fixes
- The README describes features that do not exist. Paste your real scripts and commands, and keep the "only use commands I gave you" rule.
- Setup steps fail on a fresh machine. Follow the quick start yourself in a new folder or container and fix any missing step.
FAQ
What should every README include?
What the project does, how to install and run it, how to configure it, a usage example and the licence. Everything else is optional.
Should the README be long?
Keep it short enough to scan. Move detailed guides to a docs folder and link to them.