readme-generator
Skill0 starsChanged 4 months agoMITView on GitHub
Create or rewrite `README.md` for a repo. Use when the user wants a clearer landing page, setup guide, open-source intro, project overview, or README refresh rooted in the actual repo rather than generic boilerplate.
37 other projects use a version of this.
Adopted by
Most recently taken up by
- dmccreary/ibook-skillstheir own version, first seen Nov 3, 2026
- Sagargupta16/agent-recipestheir own version, first seen Nov 1, 2026
- jaskirat1616/grok-skillstheir own version, first seen Nov 1, 2026
- wedsamuel1230/arduino-skillstheir own version, first seen Nov 1, 2026
- Tejas9406/vibe-coding-ostheir own version, first seen Nov 1, 2026
- weininghui/skillstheir own version, first seen Oct 30, 2026
Used with
Projects with it also use book-chapter-generator, concept-classifier and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
vishalsachdevSkillbook-chapter-generator
This skill generates a structured chapter outline for intelligent textbooks by analyzing course descriptions, learning graphs, and concept dependencies. Use this skill after the learning graph has been created and before generating chapter content, to design an optimal chapter structure that respects concept dependencies and distributes content evenly across 6-20 chapters.
Also in 3 projects that use this
- vishalsachdevSkill
concept-classifier
Create an interactive classification quiz MicroSim using p5.js where students read scenarios and classify them into the correct category from multiple choice options. Uses a data.json file for easy question editing. Ideal for teaching students to recognize patterns, identify types, or categorize examples across any subject domain.
Also in 3 projects that use this
JayRHaSkillchangelog-keeper
Maintains a CHANGELOG.md in the Keep a Changelog format with Semantic Versioning, grouping user-facing entries under Added/Changed/Deprecated/Removed/Fixed/Security and cutting dated releases from an Unreleased section. Use this skill when the user asks to "update the changelog", "add a changelog entry", "cut a release", "bump the version", "what changed since the last release", or to create/clean up a CHANGELOG.md or release notes.
Also in 3 projects that use this
ATOM00blueSkillerror-message-explainer
Explains errors, stack traces, exceptions, and cryptic build/runtime messages in plain language, identifies the root cause, and gives a concrete fix. Use when the user pastes an error, stack trace, traceback, panic, compiler error, or failing log and asks what it means, why it happens, or how to fix it.
Also in 3 projects that use this
peopleforresterSkillrefactoring-guide
Safe refactoring patterns and techniques. Use when the user wants to improve code structure, reduce duplication, or make code more maintainable without changing behavior. Emphasizes incremental changes with test coverage.
Also in 3 projects that use this
- +7 more from vishalsachdev
Other versions37 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 37
- serejaris/personal-corp-os★ 243same name
- serejaris/ris-claude-code★ 243same name
- dmccreary/claude-skills★ 110same name
- dmccreary/ibook-skills★ 110same name
- anchildress1/awesome-ai★ 67same name
- anchildress1/awesome-github-copilot★ 67same name
- MCDxAI/minecraft-dev-mcp★ 47same name
- geekjourneyx/readme-generator★ 44same name
- glincker/claude-code-marketplace★ 37same name
- johnqtcg/awesome-skills★ 30same name
27 more not listed
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 repository37 other files it gives its agents.
- adr-logSkill
- adversarial-reviewSkill
- ai-writing-detoxSkill
- autonomous-video-pipelineSkill
- browser-tutorial-videoSkill
- codex-execution-packSkill
- continuity-ledgerSkill
- github-mobile-opsSkill
- github-seoSkill
- idea-validationSkill
- illustration-promptSkill
- issue-control-loopSkill
- justdoitSkill
- lazy-seniorSkill
- long-context-dispatchSkill
- openclaw-councilSkill
- parallel-worktreesSkill
- playwrightSkill
- product-councilSkill
- product-shapingSkill
- public-artifact-laneSkill
- screenshotSkill
- session-to-postSkill
- spec-bundleSkill
- spreadsheetSkill
- spreadsheet-tabular-analysisSkill
- spreadsheet-xlsx-editSkill
- tool-scoutSkill
- transcribe-basicSkill
- transcribe-diarizeSkill
- transcribeSkill
- triage-findingSkill
- video-builderSkill
- video-render-runSkill
- video-spec-builderSkill
- visual-explainerSkill
- work-shapingSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 31 edited versions we read keep these.
3
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 10
Do not use when: the repo facts are unknown and no source artifacts are available to ground the README.
- Distinctive: line 17
Read the repo before drafting: existing README.md, package or build manifests, main entrypoints, and tests when useful.
- Distinctive: line 19
Write for an outsider, not for an agent.
“Common” is measured: kept by at least 6 in 10 of the 31 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
Metadata
- Trigger when: the real task is README quality, not feature implementation.
- Do not use when: the repo facts are unknown and no source artifacts are available to ground the README.
Skill Purpose
Produce a human-first README that quickly tells an outsider what the repo does, how to start, and what matters, without turning the page into API dump clutter.
Instructions
- Read the repo before drafting: existing
README.md, package or build manifests, main entrypoints, and tests when useful. Preserve true facts and cut stale or duplicated material. - Choose the smallest honest README shape for the repo type. Use
~/.codex/skills/readme-generator/references/section-matrix.mdwhen you need the section matrix. Add only the sections that materially reduce confusion. - Write for an outsider, not for an agent. Browse only when current official framework docs materially affect setup or usage, and prefer primary docs when you do.
Non-Negotiable Acceptance Criteria
- The first screen explains value and has a truthful quick start.
- Usage examples match the real repo interface.
- The README does not become an API dump, internal note file, or architecture lecture unless the repo genuinely needs that.
- Limitations or unstable status are named when they matter.
Output
- The updated
README.mdpath. - A short note on the chosen section set and the repo type it was optimized for.
- Any external docs used to verify setup or usage details.
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.