Generate and maintain README.md files with project type detection and badge selection.
npx skills add https://github.com/christophevg/c3 --skill readme-christophevg
Please help me install this Agent Skill. Skill: readme Source: https://github.com/christophevg/c3/tree/main/skills/readme Command: npx skills add https://github.com/christophevg/c3 --skill readme-christophevg
This Skill helps you create, update, and validate project README.md files so users can understand, install, run, and trust your project quickly—without guessing or digging through internal docs.
Ask the Skill to update the README for your repository after you made changes, for example: update the README to match the current project structure and add the correct end-user quick start and badges.
High-intent search queries and answers about installing and using this skill.
To generate a README, the Skill detects your project type, such as a Python package or web app, and creates a tailored README structure. It fills missing sections and selects appropriate Shields.io badges to ensure end users can quickly understand and run your project.
A valid project README requires essential sections including a clear title, a first-50-words description, a quick start guide, and license details. The Skill validates these sections against repository evidence to ensure links, badges, and content align with your actual project.
To keep your README synchronized after updating project features, you ask the Skill to update the documentation. It guides an iterative review process, validates the new structure, normalizes the README location, and handles any necessary moves from .github/README.md.
Shields.io badges are selected automatically based on your detected project type. For Python projects, the Skill includes specific badges indicating agentic workflow and uv expectations, enforcing a badge count limit to maintain documentation quality and end-user focus.
Yes, you can use this to move a README from the .github directory. The Skill normalizes the README location by handling .github/README.md moves, ensuring your documentation resides in the correct root location and aligns with the repository evidence.
The best way to enforce documentation quality is by validating required sections, limiting badge counts, and ensuring a clear quick start guide. The Skill checks these constraints against repository evidence to guarantee the README remains end-user focused and does not rot.
allanninalGenerate project documentation from package manifests and code structure.
bdsqqqStage modified files, commit with conventional commits, and push to the remote repository.
bordenetValidate and verify Markdown links in documentation before publishing.
Logos-LiberCompare static site generators and documentation platforms for technical documentation workflows.
