README Generator
Scans a project and generates a comprehensive README.
When to Use
- When the user asks to "generate a README", "document this project", or "write project docs"
- When a project has no README or an outdated one
Process
Scan the project structure:
- Package files (package.json, requirements.txt, go.mod, etc.)
- Source directories and entry points
- Config files, CI/CD, Docker
- Existing docs, LICENSE, CONTRIBUTING
Identify:
- Project name and description (from package.json, pyproject.toml, etc.)
- Tech stack and dependencies
- How to install and run
- How to test
- Project structure
Generate README with these sections:
# Project Name
One-line description.
## Features
- Key capabilities
## Prerequisites
- Required tools and versions
## Installation
Step-by-step setup instructions
## Usage
How to run, with examples
## Development
- How to build, test, lint
- Project structure overview
## Contributing
How to contribute (or link to CONTRIBUTING.md)
## License
License type (or link to LICENSE)
Rules
- Only include sections that are relevant to the project
- Use actual commands from the project's scripts/config (don't guess)
- Keep it concise — link to detailed docs rather than embedding everything
- Match the project's existing tone and conventions
- If a README already exists, offer to update rather than replace
1---2name: readme-generator3description: README Generator4---5# README Generator67Scans a project and generates a comprehensive README.89## When to Use1011- When the user asks to "generate a README", "document this project", or "write project docs"12- When a project has no README or an outdated one1314## Process15161. Scan the project structure:17 - Package files (package.json, requirements.txt, go.mod, etc.)18 - Source directories and entry points19 - Config files, CI/CD, Docker20 - Existing docs, LICENSE, CONTRIBUTING21222. Identify:23 - Project name and description (from package.json, pyproject.toml, etc.)24 - Tech stack and dependencies25 - How to install and run26 - How to test27 - Project structure28293. Generate README with these sections:3031```markdown32# Project Name3334One-line description.3536## Features37- Key capabilities3839## Prerequisites40- Required tools and versions4142## Installation43Step-by-step setup instructions4445## Usage46How to run, with examples4748## Development49- How to build, test, lint50- Project structure overview5152## Contributing53How to contribute (or link to CONTRIBUTING.md)5455## License56License type (or link to LICENSE)57```5859### Rules60- Only include sections that are relevant to the project61- Use actual commands from the project's scripts/config (don't guess)62- Keep it concise — link to detailed docs rather than embedding everything63- Match the project's existing tone and conventions64- If a README already exists, offer to update rather than replace
comcclelland