github-readme-generator-skill
AGENTS.md0 starsChanged 4 months agoMITView on GitHub
Use this folder to create or improve GitHub README.md files for repositories, profile READMEs, organization READMEs, libraries, CLIs, apps, and templates. Start with github-readme-generator/SKILL.md for the workflow and quality bar. Read github-readme-generator/references/readme-playbook.md for repository-specific strategy, github-readme-generator/references/badges-and-stats.md for Shields.io and GitHub Stats Extended patterns, and github-readme-generator/references/resource-catalog.md when choosing external README polish resources. Use the renderer in github-readme-generator/scripts/ when a deterministic first draft is useful, then edit the README for repository-specific accuracy. Core behavior:
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,700 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- github-readme-generatorSkill
The file
We split this AGENTS.md into the rules it gives an agent
5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 3
Use this folder to create or improve GitHub README.md files for repositories, profile READMEs, organization READMEs, libraries, CLIs, apps, …
- Distinctive: line 11
Use a compact badge row, not a badge wall.
- Distinctive: line 12
Prefer concrete commands from the repo over placeholders.
- Distinctive: line 13
Add conditional sections from actual repo signals: docs, examples, screenshots, CI, env files, Docker, license, changelog, and contribution …
- Distinctive: line 14
Verify badge URLs, links, commands, and generated stats URLs before finishing.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.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
Use this folder to create or improve GitHub README.md files for repositories, profile READMEs, organization READMEs, libraries, CLIs, apps, and templates.
Start with github-readme-generator/SKILL.md for the workflow and quality bar. Read github-readme-generator/references/readme-playbook.md for repository-specific strategy, github-readme-generator/references/badges-and-stats.md for Shields.io and GitHub Stats Extended patterns, and github-readme-generator/references/resource-catalog.md when choosing external README polish resources. Use the renderer in github-readme-generator/scripts/ when a deterministic first draft is useful, then edit the README for repository-specific accuracy.
Core behavior:
- Inspect the repository before writing.
- Lead with a clear value proposition and fast-start path.
- Use a compact badge row, not a badge wall.
- Prefer concrete commands from the repo over placeholders.
- Add conditional sections from actual repo signals: docs, examples, screenshots, CI, env files, Docker, license, changelog, and contribution files.
- Verify badge URLs, links, commands, and generated stats URLs before finishing.
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.