github-readme-generator-skill
CLAUDE.md0 starsChanged 4 months agoMITView on GitHub
Follow github-readme-generator/SKILL.md to create polished GitHub README.md files. Load github-readme-generator/references/readme-playbook.md for deeper README strategy, github-readme-generator/references/badges-and-stats.md when adding Shields.io badges or GitHub Stats Extended cards, and github-readme-generator/references/resource-catalog.md when choosing external README tools or visual resources. When a first draft is useful, run the renderer in github-readme-generator/scripts/, then revise the output using repository context. Preserve accurate existing project details, add sections only when they help the reader act, and remove stale claims.
In this repository2 other files it gives its agents.
- AGENTS.mdAGENTS.md
- github-readme-generatorSkill
The file
We split this CLAUDE.md into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 3
Follow github-readme-generator/SKILL.md to create polished GitHub README.md files.
- Very specific: line 5
When a first draft is useful, run the renderer in github-readme-generator/scripts/, then revise the output using repository context.
≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
GitHub README Generator For Claude Code
Follow github-readme-generator/SKILL.md to create polished GitHub README.md files. Load github-readme-generator/references/readme-playbook.md for deeper README strategy, github-readme-generator/references/badges-and-stats.md when adding Shields.io badges or GitHub Stats Extended cards, and github-readme-generator/references/resource-catalog.md when choosing external README tools or visual resources.
When a first draft is useful, run the renderer in github-readme-generator/scripts/, then revise the output using repository context. Preserve accurate existing project details, add sections only when they help the reader act, and remove stale claims.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.