Write a README – README prompt for ChatGPT and Claude
Free with your account
- Free with an account
- Copy filled in or download
- Updates included
Claude Opus 5.5
This prompt writes a README for your project. Paste your notes and the key files, commands and options; you get a complete README and a list of placeholders and conflicts to check.
What you get
- A complete README in Markdown: what it does, install, quick start, options, examples and limits
- Every option, flag and environment variable from your files in one table
- Placeholders such as [add license] instead of invented facts
- A list of placeholders to fill and conflicts between your notes and your files
How to use it
- 1Write a few lines of notes
Say what the project does, who it is for and how finished it is.
- 2Paste the files that define it
Add the package file, the CLI help or main options, the environment variables and the commands you use.
- 3Fill the gaps and try the commands
Replace every placeholder, settle each conflict it lists, and run each command in a clean folder before you publish.
Better results
- Paste the real output of one run, as in the example, so the quick start shows true output instead of an invented one.
- Ask a follow-up: "Write a CONTRIBUTING.md from the Development section" if you want outside contributors.
- Run the prompt again when you add an option, so the configuration table keeps up with the code.
Questions
Can ChatGPT write a README?
Yes, ChatGPT writes a good README when you paste the project's package file, commands and options. Without them it invents install steps and flags that do not exist, so give it the real files and ask for placeholders where facts are missing.
What should a README include?
A README should include what the project does and who it is for, requirements, install steps, a quick start, configuration options, usage examples, how to develop and test it, known limits and the license. Short projects can merge some of these sections.
Can AI write API documentation?
Yes, AI writes good API documentation from the real material: route definitions, request and response types, and example calls. Paste those rather than describing them, and check every endpoint and field name against the code before you publish.
Updated 6 Oct 2026
























