| name | readme-generator |
| description | Generate a professional GitHub README with status badges, visual overview infographic, Mermaid diagrams, artifact navigation, team information, and timeline summary. Use as the final documentation step after all artifacts are complete. |
| allowed-tools | Read, Grep, Glob |
Generate README.md at the repository root using data from all completed artifacts.
Process
- Read all completed artifacts to extract summary data
- Create status badges (shields.io format)
- Embed infographic with dark mode support via
<picture> element
- Build Mermaid phase diagram
- Create complete artifact index with links
- Summarize team roles and milestones
Required Sections
- Title + Badges: Project name, status/duration/target/ROI badges
- One-line description with key metric
- Infographic:
<picture> element with dark mode support referencing .github/readme-infographic.svg
- Problem: 2-3 sentences with metrics table (Metric | Current | Target | Improvement)
- Approach: Mermaid
graph LR showing phases, color-coded
- Domain-Specific Key Section: Top items table relevant to the problem
- Financial Impact: Table (Category | Value) with savings, cost, ROI multiple
- Project Artifacts: Table (Document | Description) linking all .md files
- Team: Table (Role | Responsibility)
- Timeline: Table (Milestone | Week | Deliverable)
Constraints
- Under 150 lines total
- Scannable without scrolling (key info above fold)
- All internal links must resolve
- No placeholder content
Quality Criteria
