← ClaudeAtlas

general-readme-skilllisted

Use when generating or improving README.md for any project. Trigger on /readme, "generate readme", "write readme", "create project documentation", "更新README", "帮我写 README".
KieranGao/general-readme-skill · ★ 3 · AI & Automation · score 79
Install: claude install-skill KieranGao/general-readme-skill
# General README Skill Generate professional, human-feeling README files for any project. Strictly follow real project content, reject filler text and placeholder content. ## Overview Full workflow: **Configure → Scan → Generate → Beautify → Output** **Zero external dependencies.** All rules, templates and assets are embedded in the skill. No third-party CLI, runtime or network service required for core functions. ## Trigger Rules Trigger this skill when user inputs match any of the following: - Exact command: `/readme` - Text commands: generate readme, write readme, create project documentation, update readme - Chinese commands: 帮我写 README, 生成项目文档, 更新README - Scenario: User requests to create/rewrite/refresh project README --- ## Phase 1: Configuration Collect configuration options from developer before generation. All options have fixed default values for quick use. Defaults (used when user supplies no configuration): - Tone Profile = Professional - Badge Style = Flat - Primary language = English - Secondary languages = none If the user provides no configuration, use these defaults. ### 1. Tone Profile (Default: Professional) Select README writing style: - **Energetic** — Direct, confident, allow emojis in features. Reference: FastAPI style. - **Minimal** — Terse, code-first, no redundant description. Reference: Tailwind CSS style. - **Professional** — Neutral, structured, formal layout. Reference: Kubernetes style. ### 2. Badge Style (Default: Flat) Select shields.i