readme-generator
由 fratua 提供
Coding Agents & IDEs简介
Generate a production-quality README.md by analyzing project structure, framework, and code.
描述
该技能的功能
Analyzes a project's files, dependencies, and structure to produce a complete README.md. Detects the framework, package manager, license, and test setup automatically. Adapts output sections to the specific project type.
Manually writing a README requires cross-referencing package files, inferring commands, and structuring sections by hand — this skill does all of that in one pass.
何时使用
- Adding a README to a new open source repo before first publish
- Onboarding contributors to an undocumented internal tool
- Generating a README after inheriting a legacy codebase
- Documenting a CLI tool's flags and usage from source
- Refreshing an outdated README after major refactors
示例工作流
User asks: generate a readme for my project
- 1
Reads package.json, pyproject.toml, or other manifests to extract name, description, and dependencies
- 2
Detects framework from dependency signals and config files
- 3
Determines install and run commands from lockfile type and scripts
- 4
Scans for license file, CI workflows, Docker config, and test directories
- 5
Writes a structured README.md with only the sections relevant to the detected project type
README.md written to project root with badges, install instructions, usage examples, and framework-specific sections
安装
clawhub install fratua/readme-generator运行 CLI 命令,或把这段提示词粘贴到 Claude Code、Cursor、Codex 或你在用的任意编程智能体里。