Analyze project structure, code, and existing docs to generate an accurate README.md.
Steps
- Analyze project: name, purpose, tech stack, directory structure, build system, key features
- Determine README sections: overview, features, prerequisites, installation, usage, configuration, structure, development, doc links
- Generate README content:
- Clear project description
- Code blocks for commands
- Table of contents if long
- Link to docs/ for details
- Show for approval; backup existing README if present
Structure
# Project Name
[One-line description]
## Overview / ## Features / ## Prerequisites / ## Installation / ## Usage
## Configuration / ## Project Structure / ## Development / ## Documentation / ## License
Notes
- Keep brief - README is overview, not full docs
- Focus on "getting started" info
- Include actual commands, not placeholders