readme-generator
Skill1 starsChanged 5 days agoMITView on GitHub
Generate or refresh a project README grounded in the actual repository. Use when a project has no README, a stale one, or you want install/usage/scripts/structure sections that match the real code.
- Installs packages
39 other projects use a version of this.
Adopted by
Most recently taken up by
- dainch/my-skillstheir own version, first seen Nov 16, 2026
- 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
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
vishalsachdevSkillconcept-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 versions39 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 39
- serejaris/personal-corp-os★ 244same name
- serejaris/ris-claude-code★ 243same name
- dmccreary/ibook-skills★ 112same name
- dmccreary/claude-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
- jshsakura/awesome-opencode-skills★ 31same name
29 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 repository163 other files it gives its agents.
- agents.mdAGENTS.md
- 3d-asset-handoff-sheetSkill
- accessibility-regression-auditorSkill
- adr-writerSkill
- agent-memory-designerSkill
- agent-trajectory-evaluatorSkill
- alerting-rules-tunerSkill
- analysis-memo-writerSkill
- annotation-disagreement-ledgerSkill
- annotation-task-spec-builderSkill
- api-deprecation-plannerSkill
- api-error-contract-designerSkill
- architecture-diagram-generatorSkill
- asset-metadata-review-ledgerSkill
- auth-flow-reviewerSkill
- background-job-reliability-auditorSkill
- branch-rebaserSkill
- brand-voice-profilerSkill
- bundle-analyzerSkill
- cache-policy-designerSkill
- canary-release-plannerSkill
- caption-correction-ledgerSkill
- changelog-from-prsSkill
- chart-chooserSkill
- chunking-strategy-optimizerSkill
- circular-dependency-breakerSkill
- claude-settings-auditorSkill
- code-example-verifierSkill
- cold-email-deliverability-auditorSkill
- cold-start-optimizerSkill
- commit-splitterSkill
- competitor-teardownSkill
- component-spec-writerSkill
- connection-pool-tunerSkill
- content-repurposerSkill
- contract-obligation-registerSkill
- contract-test-designerSkill
- conventional-commitsSkill
- cors-configuratorSkill
- coverage-gap-finderSkill
- crm-export-auditorSkill
- dashboard-designerSkill
- data-retention-auditorSkill
- dataset-first-lookSkill
- dead-code-finderSkill
- deadlock-diagnoserSkill
- decision-log-reconcilerSkill
- dependency-auditSkill
- dependency-upgrade-plannerSkill
- design-brief-writerSkill
- design-critique-checklistSkill
- design-token-extractorSkill
- devcontainer-designerSkill
- distributed-tracing-instrumenterSkill
- dockerfile-optimizerSkill
- email-sequence-drafterSkill
- embedding-index-tunerSkill
- embedding-set-inspectorSkill
- entity-match-candidate-ledgerSkill
- exit-ticket-builderSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 32 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 22
Detect the stack — do not guess: Read the manifest that exists rather than assuming:
- Very specific: line 84
Every command above came from the project's real scripts.
“Common” is measured: kept by at least 6 in 10 of the 32 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
Produce a README.md that reflects what the repository actually contains — not a generic template. The skill detects the stack, build tooling, runnable scripts, entry points, and directory layout by reading real manifest files, then assembles a title, a one-line plus short description, and install / usage / scripts / project-structure sections. Every command it prints is one the project can actually run, so a new contributor can clone, install, and start without guessing.
When to use this skill
- A project has no README, or an outdated one that no longer matches the code.
- You want install and usage instructions derived from the real
package.json/Makefile/pyproject.toml, not boilerplate. - You need a consistent, scannable README with the standard sections (install, usage, scripts, structure) in one pass.
[!WARNING] Never invent features, flags, or commands. If a script, entry point, or env var is not in the repo, it does not go in the README. When something is genuinely unknown (license, deploy target), insert a clearly marked
<!-- TODO -->rather than fabricating it.
Instructions
- Locate the project root and existing README. Glob for
README*at the root. If one exists, read it — preserve hand-written prose (project purpose, badges, screenshots, license) and only regenerate the mechanical sections. Treat the code as the source of truth where they disagree. - Detect the stack — do not guess. Read the manifest that exists rather than assuming:
- Node/TS:
package.json(name, description,scripts,bin,type,engines), plustsconfig.json, lockfile (package-lock.json/pnpm-lock.yaml/yarn.lock/bun.lock/bun.lockb) to pick the right package manager. - Python:
pyproject.toml/setup.py/requirements.txt. - Go:
go.mod. Rust:Cargo.toml. Make-driven:Makefiletargets. Frameworks: infer from dependencies (next,react,fastapi,express) — do not claim a framework that isn't a dependency.
- Node/TS:
- Extract install and usage facts. Map the detected manager to the install command (
npm install,pnpm install,pip install -e .,cargo build). Find the entry point (main/bininpackage.json,cmd/in Go,__main__.py). Pull the dev/start/build commands straight fromscriptsorMakefiletargets — quote them verbatim. - Map the structure. Glob the top-level directories and a shallow level below, ignoring
node_modules,.git,dist,build, and.next. Annotate each meaningful directory with one short phrase describing what lives there, based on what you actually find. - Assemble the README. Write
README.mdwith: an#H1 title (from manifestname), a one-line tagline, a short paragraph, then## Installation,## Usage,## Scripts(a table of every script + its command), and## Project structure(a fenced tree). Keep it scannable; prefer fenced code blocks over prose for commands. - Verify against the repo. Re-check that every script in the table exists in the manifest and every path in the tree exists on disk. Run
npm run(ormake) to confirm the script list matches, if available. - Report and flag gaps. Summarize what was detected and list what you could not determine (license, badges, env-var docs, deployment) so the user can fill those
<!-- TODO -->markers.
[!TIP] Generate the scripts table directly from the
scriptsobject so it never drifts. If two scripts are obvious wrappers (buildcallingprebuild), document the public one and mention the dependency in a single line rather than listing internals.
Examples
For a detected Node/TypeScript project (package.json with name: "taskflow", a next dev style scripts block, and src/ + public/), the skill emits:
# taskflow
A task-board API and dashboard built with Next.js and TypeScript.
TaskFlow exposes a REST API for boards, lists, and cards, with a server-rendered
dashboard. State is persisted to Postgres via Prisma.
## Installation
```bash
pnpm install # lockfile detected: pnpm-lock.yaml
```
## Usage
```bash
pnpm dev # start the dev server on http://localhost:3000
```
## Scripts
| Script | Command | Description |
| ------- | ---------------- | --------------------------------- |
| `dev` | `next dev` | Run the dev server with HMR |
| `build` | `next build` | Production build |
| `start` | `next start` | Serve the production build |
| `lint` | `eslint .` | Lint with the flat ESLint config |
| `test` | `vitest run` | Run the test suite once |
## Project structure
```text
src/
app/ Next.js App Router routes and layouts
lib/ data access and shared utilities
components/ shared UI components
public/ static assets served as-is
prisma/ schema and migrations
```
<!-- TODO: add license, CI badges, and DATABASE_URL setup notes -->Every command above came from the project's real scripts; the tree lists only directories that exist. Fill the TODO marker before publishing.
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.

