general-readme-skill - Generate and improve project README files
Scans project files and generates or improves README.md content using detected project details, configured language, tone, and badge style.
Tags
Updated: 2026-10-01Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Configure README options
- Scan static project files
- Detect project technologies
- Detect project architecture
- Detect API styles
- Detect licenses
- Detect contributors
- Generate README sections
- Preserve manual content
- Output README files
Inputs
- Local project directory
- README configuration options
- Reference files
Outputs
- Generated README.md file
- Generation status message
- Missing-reference error message
- Contributor availability note
Requirements
- Read, Grep, and Glob tools
- Read access to project files
- Readable reference files
- No third-party dependencies