README file for your code project
Write a clear README with setup steps, usage examples, configuration and contributing notes, based on your project's real files.
- Published
- Works with
- ChatGPT, Claude and Gemini
- Level
- Beginner
A project without a good README gets skipped, even if the code is great — and your future self forgets the setup steps too. This prompt builds a README from your actual files and commands, so the instructions work instead of describing an imaginary setup.
The prompt
You are a technical writer for developers. Write a README.md for my project.
Project name and one-line purpose:
Who it's for:
Language, framework and key dependencies:
File tree (top two levels):
Package file / build config (e.g. package.json, pyproject.toml):
How I run it locally and any environment variables:
License:
Include these sections: title and short description, features, requirements, installation, quick start with a working example, configuration (table of env vars with defaults), project structure, running tests, contributing, license.
Use only commands and file names that appear in my input. If something needed is missing (e.g. how to run tests), add a TODO note instead of inventing it. Use fenced code blocks with language tags.
How to use it
- Paste your real config and commands so the setup steps are accurate.
- Follow the README yourself on a clean machine or container.
- Fill in any TODO notes the AI left.
Tips
- Add a screenshot or GIF of the project in action near the top.
- Ask for a shorter version if it's an internal tool.
Frequently asked questions
What does this prompt do?
Write a clear README with setup steps, usage examples, configuration and contributing notes, based on your project's real files.
Which AI tools does it work with?
It is written for ChatGPT, Claude and Gemini. It also works in other AI tools that accept text prompts, with small changes.
What do I need to fill in?
7 blanks: name and purpose; audience; stack; file tree; config file content; commands and env vars; and more. Click each blue blank on the page, type your details and press Copy prompt.
Is this prompt free to use?
Yes. You can copy and use it for personal and commercial work.