README
Skill1 starsChanged 8 days agoMITView on GitHub
Create, standardize, or translate a README following the harness template, with a centered header, badges, language selector and consistent sections. Use when the user asks to write, rewrite, update, standardize or translate a README.
38 other projects use a version of this.
Adopted by
Most recently taken up by
- GoBeromsu/craft-skillstheir 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
- computerlovetech/skillstheir own version, first seen Nov 16, 2026
- Xia-Ataraxia/craft-skillstheir own version, first seen Nov 8, 2026
Used with
Projects with it also use favicon, build and 6 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 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
GitHubSkillrefactor
Surgical code refactoring to improve maintainability without changing behavior. Covers extracting functions, renaming variables, breaking down god functions, improving type safety, eliminating code smells, and applying design patterns. Less drastic than repo-rebuilder; use for gradual improvements.
Also in 3 projects that use this
BlockSkillplan
Draft a TDD, PRD, or lightweight plan in the conversation without committing it.
Also in 3 projects that use this
GoogleSkillprototype
Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right, or explore what a UI should look like.
Also in 3 projects that use this
SentrySkillcommit
Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.
Also in 3 projects that use this
Other versions38 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 38
- getkyo/kyo★ 820same 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
28 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 repository9 other files it gives its agents.
- AGENTS.mdAGENTS.md
- templates/AGENTS.mdAGENTS.md
- Add skillSkill
- Commit and pushSkill
- GitHub PagesSkill
- Logo designSkill
- Project setupSkill
- Release cutSkill
- Release summarySkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
16 rules. 0 are common, 13 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 38 edited versions we read keep these.
13
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Write or restructure a README using the template in references/template.md.
- Distinctive: line 23
Never infer features. Use what the repository and the user provide.
- Distinctive: line 27
Ask in one round:
- Distinctive: line 38
Do not add a section you cannot fill truthfully.
- Very specific: line 73
Create README.pt-BR.md and/or README.es.md only when chosen.
- Very specific: line 77
Keep the same language selector in every file, in this order: English | Português (Brasil) | Español
- Distinctive: line 79
Do not translate badges, version numbers or brand names.
- Distinctive: line 83
Read the current README before writing.
- Distinctive: line 84
Keep useful commands, features and notes.
- Distinctive: line 85
Do not delete content without explicit approval.
- Distinctive: line 93
Every language link points to an existing file.
- Distinctive: line 95
No secret, token, local path or agent attribution appears.
- Distinctive: line 106
Never invent features, commands or screenshots.
- Distinctive: line 107
Never add a language file without the matching selector entry.
- Distinctive: line 108
Never overwrite unrelated sections without approval.
- Distinctive: line 109
Never add AI attribution or tool mentions.
“Common” is measured: kept by at least 6 in 10 of the 38 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
Write or restructure a README using the template in
references/template.md. The English file is canonical; translations mirror its
structure.
1. Inspect the repository
Collect:
- existing
README.md,README.pt-BR.md,README.es.md; - the license file and type;
- logo candidates (
assets/logo.png,assets/images/logo.png,icon.png, ...); - the project description from a manifest, if any;
- the default branch and remote (
git remote get-url origin); - existing workflows under
.github/workflows/.
Never infer features. Use what the repository and the user provide.
2. Ask
Ask in one round:
- Languages: English only, English + Portuguese, English + Spanish, or all three. Default to the languages that already exist; if none, ask.
- Logo: none, or a path. Suggest a detected candidate.
- Badges: CI, Release, Docs, License. Default: Release and License, plus CI
when
ci.ymlexists, plus Docs when a Pages workflow exists. - Sections: Features, Requirements, Getting started, Usage, Configuration, Development, Testing, Releasing, Contributing, License. Default to the ones the repository can support with real content.
Do not add a section you cannot fill truthfully.
3. Resolve the metadata
owner/repofrom the remote. Accept SSH and HTTPS URLs.- Project name from the user or the manifest. Use the display name, not the package slug.
- One-line description from the user or the manifest.
- License: use the file name (
LICENSE) and the detected type (MIT,Apache-2.0, ...).
4. Write the English README
Follow references/template.md:
<div align="center">
<img src="<logo>" alt="<name>" width="200" />
# <name>
<description>
[badges]
[language selector]
</div>Then the chosen sections.
5. Write translations
Create README.pt-BR.md and/or README.es.md only when chosen.
- Mirror the section order and links.
- Translate prose; keep commands, code, file names and URLs unchanged.
- Keep the same language selector in every file, in this order:
[English](README.md) | [Português (Brasil)](README.pt-BR.md) | [Español](README.es.md) - Do not translate badges, version numbers or brand names.
6. Preserve existing content
- Read the current README before writing.
- Keep useful commands, features and notes; move them into the new structure.
- Do not delete content without explicit approval.
- Show a diff before writing when a README already exists.
7. Validate
- Title matches the project display name.
- Badge URLs point to the real repository and existing workflows.
- The license badge points to
LICENSE. - Every language link points to an existing file.
- Section headings are consistent across languages.
- No secret, token, local path or agent attribution appears.
- Relative links resolve.
8. Hand off
Report the files created or changed, the chosen languages, the badges, the sections included and anything the user must fill in. Do not commit, push or tag unless the user asks.
Boundaries
- Never invent features, commands or screenshots.
- Never add a language file without the matching selector entry.
- Never overwrite unrelated sections without approval.
- Never add AI attribution or tool mentions.
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.

