generate-readme

1# Generate README
2 
3Transform codebase analysis into a clear, welcoming README.md that helps engineers quickly understand the project.
4 
5## Workflow
6 
7### 1. Gather analysis data
8 
9Check for existing analysis documents in `<repo>/.ai/docs/` (structure, dependency, data-flow, request-flow, API analyses). They may have been produced by the `analyze-codebase` skill.
10 
11- **If they exist**: use them as your primary source, but spot-check key claims against the code — they may be stale.
12- **If they don't exist**: offer to run the `analyze-codebase` skill first (better results, reusable artifacts). If the user declines or wants it quick, explore the codebase directly yourself before writing.
13 
14### 2. Handle the existing README
15 
16Ask the user (or infer from their request) whether to incorporate the existing README:
17 
18- **Incorporate** (default when a README exists): read it first; keep useful, still-accurate information — especially manually written content like setup quirks, badges, links, and licensing. Verify claims against the code; the old README may be outdated.
19- **From scratch**: ignore the existing file entirely.
20 
21### 3. Write the README
22 
23Include the following sections, in this order, unless the user excludes some. Only use these headlines plus any carried over from the existing README — don't invent extra sections.
24 
25- **Project Overview** — title, concise description, purpose, key features, likely use cases.
26- **Table of Contents** — for READMEs long enough to need one.
27…