readme
Skill4 starsChanged 5 months agoMITView on GitHub
Create or update a root README.md file for any project repository. Use when a user asks to create a README, generate a README for a project, write project documentation, update an existing README, or improve a README. Also use when setting up a new project and the user wants a polished README file.
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 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.
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 repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-friendly-tuiSkill
- copilot-sdk-nodejsSkill
- image-genSkill
- impactful-titlesSkill
- public-tunnelSkill
- reverse-specSkill
- telegram-sendSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
17 rules. 0 are common, 15 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 39 edited versions we read keep these.
15
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Create comprehensive, well-structured, and appealing README.md files for projects.
- Distinctive: line 62
Use GFM (GitHub Flavored Markdown)
- Distinctive: line 63
Use GitHub admonition syntax for callouts:
- Very specific: line 80
Use <details> for collapsible sections when offering alternative setup methods
- Very specific: line 81
Use centered <div align="center"> for the header block (logo, title, badges, nav links)
- Distinctive: line 82
Use flat-square badge style consistently
- Distinctive: line 83
Use bold text for feature names in feature lists
- Distinctive: line 88
Do not overuse emojis (a few are fine, especially in feature lists)
- Distinctive: line 89
Write in a clear, professional tone
- Distinctive: line 90
Use code blocks with language identifiers for all code/command examples
- Distinctive: line 91
Prefer actionable instructions ("Run this command") over passive descriptions
- Distinctive: line 96
Do NOT include these sections — they have dedicated files:
- Distinctive: line 109
After writing or updating the README:
- Distinctive: line 111
Verify all links point to existing files/URLs
- Distinctive: line 112
Ensure commands and code examples are accurate
- Distinctive: line 113
Check that badge URLs are correct
- Distinctive: line 115
If updating an existing README, ensure no important existing content was lost
“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
README Creator
Create comprehensive, well-structured, and appealing README.md files for projects.
Workflow
- Analyze the project thoroughly
- Determine project type and appropriate README structure
- Generate or update the README.md
- Validate the result
Step 1: Analyze the Project
Examine the entire repository to understand its context. Look for:
- Project identity: package.json, pyproject.toml, Cargo.toml, go.mod, pom.xml, etc.
- Purpose: Existing README, docs folder, description fields, comments
- Tech stack: Languages, frameworks, libraries, build tools
- Project type: Application sample, CLI tool, library, monorepo, API, etc.
- Entry points: How users install, configure, and run the project
- Key features: What sets this project apart
- Architecture: Directory structure, diagrams, component relationships
- Development setup: Prerequisites, environment setup, dev containers, codespaces
- Deployment: Cloud deployment, CI/CD, Docker, infrastructure-as-code
- Assets: Logo, icons, screenshots, demo GIFs in docs/images or similar folders
Step 2: Determine Structure
Choose sections based on the project type. Not all sections apply to every project.
Common sections (most projects)
- Title with logo/icon (if available)
- Badges (build status, version, license, language)
- Short description / tagline
- Navigation links to major sections
- Screenshot or demo GIF (if available)
- Overview (for larger projects)
- Features
- Getting started / Installation
- Usage / Running
- Resources / Links (if relevant)
- Troubleshooting / FAQ (if relevant)
Additional sections by project type
Application samples: Prerequisites, deployment instructions, architecture diagram, cost estimation CLI tools: Installation (npm/brew/etc.), command line options, examples Libraries: Installation, API reference or link to docs, examples Monorepos: Project structure table, links to sub-project READMEs
Step 3: Write the README
Formatting rules
- Use GFM (GitHub Flavored Markdown)
- Use GitHub admonition syntax for callouts:
> [!NOTE] > Informational note. > [!TIP] > Helpful tip. > [!IMPORTANT] > Critical information. > [!WARNING] > Warning about potential issues. > [!CAUTION] > Dangerous action warning. - Use
<details>for collapsible sections when offering alternative setup methods - Use centered
<div align="center">for the header block (logo, title, badges, nav links) - Use flat-square badge style consistently
- Use bold text for feature names in feature lists
Style guidelines
- Be concise and to the point — avoid filler text
- Do not overuse emojis (a few are fine, especially in feature lists)
- Write in a clear, professional tone
- Use code blocks with language identifiers for all code/command examples
- Prefer actionable instructions ("Run this command") over passive descriptions
- Include a star call-to-action if appropriate ("⭐ If you like this project, star it on GitHub")
Sections to exclude
Do NOT include these sections — they have dedicated files:
- LICENSE
- CONTRIBUTING
- CHANGELOG
- CODE_OF_CONDUCT
- SECURITY
Reference examples
See references/examples.md for structural patterns extracted from high-quality READMEs.
Step 4: Validate
After writing or updating the README:
- Verify all links point to existing files/URLs
- Ensure commands and code examples are accurate
- Check that badge URLs are correct
- Confirm the structure matches the project type
- If updating an existing README, ensure no important existing content was lost
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.

