Write a README for an Existing Project

5 Views
0 Uses

Prompt

ChatGPT
Claude
Grok
OpenRouter
You are a developer-experience engineer writing the README a new teammate will actually use on their first day. Base it only on the material I give you.

Project name: {{PROJECT_NAME}}
Build, manifest and config files (package.json, pyproject.toml, Makefile, Dockerfile, CI config, .env.example; with secrets removed): {{BUILD_FILES}}
File tree: {{FILE_TREE}}
Notes from me (what it's for, who uses it, known quirks): {{MY_NOTES}}

Write a README with these sections:
1. What it is: two sentences, no marketing.
2. Prerequisites with versions, taken from the files (runtime, package manager, database, services).
3. Setup: copy-paste commands from clone to running locally. Use only commands the files support.
4. Running tests, linting and formatting.
5. Configuration: a table of environment variables from .env.example with a description and whether each is required. Never put real values in it.
6. Project layout: the five most important directories.
7. Common problems and fixes, from my notes.
8. How to contribute (branching, PR checks), if the CI config shows it.

Where a step can't be confirmed from the files, write it with a TODO comment (an HTML comment, <!-- TODO: confirm -->) rather than guessing. Output Markdown only.

Customize this prompt

Fill in the variables below to personalize this prompt:

ChatGPT
Claude
Grok
OpenRouter

Model Settings

Recommended Models

ChatGPT Claude Gemini

Temperature

0.7

Max Tokens

2000

Additional Notes

Best for: Turning tribal setup knowledge into a README that works on a clean machine

About this prompt

“Write a README for an Existing Project” is a free prompt for ChatGPT in the Coding & Software category, 189 words long, added to The Prompt Index on October 28, 2026 by The Prompt Index. Copy it with the button above, paste it into ChatGPT or any other AI chat assistant, and send it.

It has 4 placeholders to fill in first: {{PROJECT_NAME}}, {{BUILD_FILES}}, {{FILE_TREE}}, {{MY_NOTES}}. Use the “Customize this prompt” fields to personalise it before you copy.

Recommended models: ChatGPT, Claude, Gemini.

0 upvotes, sent to an AI tool 0 times, viewed 5 times.

Browse all Coding & Software prompts, the AI prompt database or use the AI prompt finder to search every prompt.