readme
Skill2 starsChanged 4 months agoMITView on GitHub
Generate or update a project README from the codebase — what it is, how to install, run, test, and configure it. Use when the user says "write a README", "generate a readme", "update the README", "document this project", "my README is out of date", or "create project docs".
- Reads credentials
39 other projects use a version of this.
Adopted by
Most recently taken up by
- AtilaMedeiros/skillstheir own version, first seen Nov 16, 2026
- GoBeromsu/craft-skillstheir own version, first seen Nov 16, 2026
- gabrielSantosLima/harnesstheir own version, first seen Nov 16, 2026
- wufangci/READMEtheir own version, first seen Nov 16, 2026
- albertogrande/readme-skilltheir own version, first seen Nov 16, 2026
- yassine-krichen/claude-code-agentic-setuptheir own version, first seen Nov 16, 2026
Used with
Projects with it also use favicon, glossary and 9 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.
cpiprintSkillfavicon
Generate favicons from a source image
Also in 3 projects that use this
Microsoft AzureSkillglossary
Short glossary of domain terms used by the team.
Also in 3 projects that use this
jaydubya818Skillhow
Use for runtime, ownership, layering, code-walkthrough, and placement questions.
Also in 3 projects that use this
jaydubya818Skillwhy
Use when design rationale must be recovered from source history and available records.
Also in 3 projects that use this
0xSeroSkillsecurity
Also in 3 projects that use this
Microsoft AzureSkillbuild
Build the TypeSpec Rust emitter from source. Run this after cloning the repo, after pulling changes, or when TypeScript source files have been modified.
Also in 3 projects that use this
- +1 more from Azure
Other versions39 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 39
- getkyo/kyo★ 823same name
- statelyai/skills★ 50same name
- sampleXbro/agentsmesh★ 27same name
- wpgaurav/WordPress-skills★ 19same name
- danvega/skills★ 15same name
- kasperjunge/agent-resources-legacy★ 9same name
- harlan-zw/brundlefly★ 7same name
- lawless-m/claude-skills★ 6same name
- ephemerallyCaden/write-readme★ 5same name
- computerlovetech/skills★ 4same 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 repository68 other files it gives its agents.
- a11ySkill
- api-docsSkill
- audit-logSkill
- benchmarkSkill
- bisectSkill
- cacheSkill
- changelogSkill
- cherry-pickSkill
- ci-setupSkill
- codeownersSkill
- commit-messageSkill
- connection-poolSkill
- contributingSkill
- coverageSkill
- db-migrateSkill
- dead-codeSkill
- debugSkill
- depsSkill
- diagramSkill
- dockerizeSkill
- docstringSkill
- e2eSkill
- env-exampleSkill
- error-handlingSkill
- explainSkill
- feature-flagSkill
- flaky-testSkill
- gitignoreSkill
- graceful-shutdownSkill
- graphqlSkill
- healthcheckSkill
- i18nSkill
- idempotencySkill
- licenseSkill
- lint-fixSkill
- loggingSkill
- migrateSkill
- mockSkill
- onboardSkill
- optimizeSkill
- paginationSkill
- pr-descriptionSkill
- pre-commitSkill
- profileSkill
- prune-branchesSkill
- rate-limitSkill
- rebaseSkill
- refactorSkill
- regexSkill
- releaseSkill
- resolve-conflictsSkill
- retrySkill
- review-diffSkill
- scaffoldSkill
- secrets-scanSkill
- security-headersSkill
- seedSkill
- soft-deleteSkill
- sqlSkill
- squashSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 39 edited versions we read keep these.
4
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 25
Identify the project: Read the manifests, entry points, and config to determine the name, purpose, language, framework, and runtime.
- Distinctive: line 27
Decide create vs update: If a README already exists, preserve its structure, tone, and any hand-written sections (badges, screenshots, …
- Distinctive: line 52
Document only what exists.
- Very specific: line 53
Every command you list must come from a real script/Makefile/CI target — verify it exists before writing it.
- Distinctive: line 55
Keep it skimmable: headings, short paragraphs, fenced code blocks for commands.
“Common” is measured: kept by at least 6 in 10 of the 39 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
Project signals
!ls 2>/dev/null
!cat package.json pyproject.toml Cargo.toml go.mod composer.json 2>/dev/null | head -80
!ls Makefile docker-compose.yml Dockerfile .env.example LICENSE* CONTRIBUTING* 2>/dev/null
!cat README* 2>/dev/null | head -80
Instructions
Generate or update the project's README.md (focus on the $ARGUMENTS section if one was named). Write for a developer who just landed on the repo and wants to understand and run it quickly.
Method
- Identify the project. Read the manifests, entry points, and config to determine the name, purpose, language, framework, and runtime. Don't infer purpose from the directory name alone — confirm it in code or existing docs.
- Pull real commands. Take install/build/run/test commands from
scriptsin package.json, a Makefile,pyproject.toml/Cargo.toml, CI config, or CONTRIBUTING — not from convention. Note required env vars (check.env.example) and services (e.g. docker-compose). - Decide create vs update. If a README already exists, preserve its structure, tone, and any hand-written sections (badges, screenshots, acknowledgements); refresh only what's stale or missing. If none exists, create one from the structure below.
- Write
README.mdat the repo root (or the path the user names).
Suggested structure
# <Project name>
<One-sentence description, then a short paragraph on what it does and why.>
## Features # optional — only if there are clear, listable capabilities
## Installation # prerequisites + the actual install steps
## Usage # the common commands / a minimal code example
## Configuration # env vars and config files, if any (link to .env.example)
## Development # build, test, lint commands; how to contribute
## License # match the LICENSE file if presentRules
- Document only what exists. Don't invent features, commands, env vars, or badges. If you can't confirm how to run something, label it clearly as a best guess rather than asserting it.
- Every command you list must come from a real script/Makefile/CI target — verify it exists before writing it.
- Match the project's tone and any existing README conventions. Omit sections that don't apply (don't write an empty "License" if there's no license).
- Keep it skimmable: headings, short paragraphs, fenced code blocks for commands. This is a front door, not a manual.
- Output raw markdown to the file. After writing, summarize what you created or changed and flag anything you marked as a guess.
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.

