readme
Installation
SKILL.md
Audit an existing README or generate one from scratch. Output is a README.md ready to commit.
Phase 1: Determine Mode
Audit mode — README.md exists in the project root. Score 8 dimensions, rewrite the weakest sections.
Generate mode — no README.md, or user explicitly asks to write one from scratch.
Gather anything missing before writing:
- What does this project do? (one sentence a stranger would understand)
- Who is it for? (specific audience, not "developers")
- How do you install it? (exact commands)
- How do you use it? (simplest possible example)
If you can answer these by reading the codebase, do that instead of asking.