write-readme
Skill2 starsChanged 15 days agoMITView on GitHub
Write or rewrite a repo's README in the user's short house style, move long technical detail to the GitHub wiki (cloned into a gitignored wiki/ folder), and create the GitHub repo if there isn't one. Use for any README request (new, rewrite, shorten, "less AI-sounding"). Args after /write-readme adjust the defaults.
13 other projects use a version of this.
Adopted by
Most recently taken up by
- protokol11/skillstheir own version, first seen Nov 8, 2026
- tada5hi/skillstheir own version, first seen Nov 1, 2026
- danielcherubini/skillstheir own version, first seen Oct 25, 2026
- kitloomlk-stack/writing-docs-kittheir own version, first seen Oct 15, 2026
- TitusKirch/skillstheir own version, first seen Oct 13, 2026
- devantler-tech/agent-skillstheir own version, first seen Oct 13, 2026
Used with
Projects with it also use implement, release and 1 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.
Hugging FaceSkillimplement
Make tests pass. Invoke after /write-tests produces failing tests.
Also in 3 projects that use this
MicrosoftSkillrelease
Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).
Also in 4 projects that use this
- MicrosoftSkill
handoff
Compact the current conversation into a handoff document for another agent to pick up.
Also in 3 projects that use this
Other versions13 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 13
- remix-run/remix★ 33ksame name
- huangwb8/skills★ 50same name
- danielcherubini/skills★ 14same name
- wolf5996/agentic-skills★ 10same name
- Yassimba/loom★ 9same name
- devantler-tech/agent-skills★ 3same name
- tada5hi/skills★ 2same name
- TitusKirch/skills★ 2same name
- protokol11/skills★ 1same name
- turntuptechnologies-ai/skills★ 1same name
3 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 repository7 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- restore-sessionsSkill
- review-skillSkill
- run-agentSkill
- test-speedupSkill
- weekly-roundupSkill
- write-reportSkill
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 11 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 24
License: No LICENSE: add MIT (user's name, current year) and tell the user so they can remove it.
- Very specific: line 30
Remove any docs/*.md the pages replace.
“Common” is measured: kept by at least 6 in 10 of the 11 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
write-readme
Short README in the user's style + detail in the GitHub wiki, done in one pass. Read references/style.md before writing; it has the template, voice rules and the sentences the user rejected.
Args are adjustments ("no wiki", "private", "name it X", "gif is docs/foo.gif"). Apply them without asking.
Steps
- Read.
README.md, the manifest (package.json/pyproject.toml/Cargo.toml) for run commands,ls docs screenshots,ls LICENSE,git remote -v,gh auth status. Skim the entry point if needed. Everything written must be true of the current code. - GitHub repo. If there's no
origin, ask with AskUserQuestion before creating anything (skip only if args already say public/private): "Create<owner>/<name>as a public repo?" with options Public (Recommended) / Private. Name = the project's name from the manifest/title in kebab-case, else the folder name. On approval:gh repo create <owner>/<name> --public|--private --source . --remote origin --push, thengh repo edit --enable-wiki. - Wiki check, early.
git ls-remote "https://github.com/<o>/<r>.wiki.git". If it fails, the wiki has never had a page (GitHub has no API to create one). Tell the user right away: "Open https://github.com/<o>/<r>/wiki/_new and click Save page", and keep working on steps 4-6 while they do it. - Hero image. Preference: a gif in
docs/, an image the user names, the widest screenshot of the main screen. Look at candidates with Read. Copy it intodocs/if its folder is gitignored. None at all: put<!-- TODO: screenshot of X -->at the top and say so. A second image is fine for a second major mode. - README. Template and voice from
references/style.md, 60-90 lines. How-it-works detail (formulas, thresholds, internals, reasoning) goes to the wiki. - License. No LICENSE: add MIT (user's name, current year) and tell the user so they can remove it. Always include the License section.
- Wiki in
wiki/. Unless args say no wiki:git clone "https://github.com/<o>/<r>.wiki.git" wikiin the repo root (retry once the user has saved the first page), and add/wiki/to.gitignoreunder a# GitHub wiki clone (its own repo)comment.- Split the old README/docs by heading into pages:
Title-Case-With-Dashes.md,# Titlefirst line,###promoted to##, text mostly verbatim. WriteHome.mdwith one line per page. Delete the placeholder page the user made. git -C wiki add -A && git -C wiki commit && git -C wiki push --force origin HEAD:master(force only to replace the placeholder; never over real pages).- Remove any
docs/*.mdthe pages replace. Link every page from the README's Documentation section. - Fall back to
docs/markdown only if the wiki can't be pushed at all; say why.
- Self-check, then commit README, LICENSE,
.gitignore, images and removed docs; push. Check each wiki page returns 200 (curl -so /dev/null -w '%{http_code}'). Report in a few lines: repo URL, what moved to which page, and thatwiki/is a clone (edit, commit and push from inside it).
Self-check
Reread the README for the tells in references/style.md. The two the user named: "not X, but Y" / "comes from Y, not Z" contrasts, and conversational filler ("actually", "really", "spits out", "nitty gritty", "that's it"). Rewrite tagline-like bullets as plain statements of what the software does.
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.