create-readmelisted

What it is — the house rules for a README: structure and tone, what a project does rather than how, no value copied from the code, one paragraph per line with no hard wrapping, no trailing full stop, no section that has its own file, no version a repository does not have, plus a checker that decides the machine-checkable half. Use when writing a README from scratch AND whenever one is edited, reviewed, restructured, or translated — the rules bite hardest on an edit, because a one-word change to a hard-wrapped paragraph reflows every line after it. Also use before adding a badge, a version claim or an admonition to one. Triggers: README, readme.md, badge, admonition, callout, project description, ридми, написать readme, поправь readme, обнови описание проекта, бейджи.
rokokol/create-readme-skill · ★ 0 · Data & Documents · score 75

Install: claude install-skill rokokol/create-readme-skill

# create-readme ## Task 1. Review the entire project and workspace, then write a well-structured README.md for it. Editing an existing one is the same job with one extra obligation: the rules below apply to the whole file, not only to the lines you touched, so a readme that already breaks rule 6 or 7 gets fixed in the same commit rather than gaining one more paragraph in the old shape. Run `check-prose.sh` on it — it takes any markdown, so the same rules cover a SKILL.md and a changelog, and it decides the machine-checkable half faster than a reading does; `check-prose.sh --help` is the reference for what it decides and what its exit codes mean 2. Follow the repository's established structure, tone and content. If none exists, use a concise, task-oriented structure rather than an unrelated project's README as a template 3. Do not overuse emojis, and keep the readme concise and to the point 4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections. Whatever the project's own licence does not cover — third-party artwork, fonts, transcribed text, colours measured off someone else's site — belongs in `ASSETS.md`, linked from an `assets` badge in the header; the disclaimer lives there and nowhere else, not also as a callout in the readme. Repository-wide maintainer rationale belongs in `WORKAROUNDS.md`, `DEVIATIONS.md` or `PITFALLS.md`, not in a duplicate readme section; link each file that exists from a header badg