readme-generator

# README Generator Generate high-quality README documents from codebase evidence, with clear structure, runnable commands, and maintenance rules. ## Core Rules - Base every statement on repository evidence (files, code, scripts, workflows, configs). - If key information is missing, write `Not found in repo` instead of guessing. - Exclude local/private tooling folders by default (for example `.codex/`) unless explicitly requested. - Keep naming/paths accurate and consistent with real repository layout. - Prefer concise sections, bullet lists, and short command blocks. - Keep internal workflow reporting out of README body by default. Evidence maps, scorecards, and verification-state reporting belong in the assistant response unless the user explicitly asks for them in the document. - Treat top-level `README.md` as a user-facing homepage first and a maintainer reference second, unless the user explicitly wants an internal-only README. ## Quick Reference | When you need to… | Jump to | |---|---| | Generate README from scratch | §Pre-Generation Gates → §Project Type Routing → §Generation Workflow | | Update an existing README | §README Update Triggers + load `references/checklist.md` | | Chinese or bilingual output | §Chinese / Bilingual README Guidelines + load `references/bilingual-guidelines.md` | | Monorepo project | §Monorepo Rules + load `references/monorepo-rules.md` | | Lightweight / small project | §Lightweight Mode | | Calibrate ToC and navigation | §README Navigati...