📝

README Generator from Codebase

Generate a professional README by analyzing the project structure

prompt template
Generate a professional README.md for my project based on this structure:

**Project name:** [NAME]
**One-line description:** [WHAT_IT_DOES]
**Tech stack:** [FRAMEWORKS_AND_TOOLS]

```
[PASTE_PROJECT_FILE_TREE]
```

**package.json scripts:**
```json
[PASTE_SCRIPTS_SECTION]
```

Generate a README with:
1. **Title and badges** — build status, license, version
2. **Description** — 2-3 sentences, what problem it solves
3. **Quick start** — clone, install, configure env, run (copy-pasteable commands)
4. **Project structure** — annotated file tree with descriptions
5. **Environment variables** — table with name, description, required/optional, example
6. **Available scripts** — what each npm script does
7. **API documentation** — brief overview of endpoints (if applicable)
8. **Contributing** — how to contribute (branch naming, commit style, PR process)
9. **License** — MIT (or specify)

Keep it scannable — use tables, code blocks, and headers. A developer should be able to go from zero to running in under 2 minutes.

How to Use This Prompt

  1. 1Copy the prompt template above
  2. 2Paste into Claude, ChatGPT, or Cursor
  3. 3Replace [bracketed placeholders] with your specific project details
  4. 4Iterate on the AI output to refine and customize the results