generate-readme
Skill38 starsChanged 8 months agoMITView on GitHub
Generate a README.md for the project. Use when the user asks to create or update the README.
8 other projects use a version of this.
Adopted by
Most recently taken up by
- kool7/claude-skillstheir own version, first seen Nov 1, 2026
- juanitourquiza/shipframetheir own version, first seen Oct 23, 2026
- microsoft/Agent365-Samplestheir own version, first seen Oct 20, 2026
- kostiantyn-matsebora/canopy-examplestheir own version, first seen Oct 11, 2026
- Jay-1409/skillstheir own version, first seen Oct 3, 2026
- eddmann/agent-toolkittheir own version, first seen Sep 22, 2026
Other versions8 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 8
- microsoft/Agent365-Samples★ 113same name
- juanitourquiza/shipframe★ 4same name
- eddmann/agent-toolkit★ 2same name
- Jay-1409/skills★ 2same name
- kool7/claude-skills★ 0same name
- kostiantyn-matsebora/canopy-examples★ 0same name
- prathakmalik/agent-standards-kit★ 0same name
- tranviet0710/agent-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository11 other files it gives its agents.
- auto-formatSkill
- review-stagedSkill
- review-stagedSkill
- container-auditSkill
- setup-projectSkill
- check-licensesSkill
- project-setupSkill
- pr-summarySkill
- ssh-helperSkill
- system-healthSkill
- test-helperSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 8 edited versions we read keep these.
2
Distinctive
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 12
If relevant, you can use this badge in the README:
- Distinctive: line 27
Write the README.md directly to the project root.
“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
README Generator Skill
Generate a comprehensive README.md for the project.
If relevant, you can use this badge in the README:
<img src="badge.png" alt="build passing" height="20" />Process
- Analyze the project structure (files, package.json, etc.)
- Generate a README with:
- Project title and description
- Installation instructions
- Usage examples
- Configuration details
Output
Write the README.md directly to the project root.
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.