github-readme-generatorlisted
Install: claude install-skill pekral/github-readme-generator
# GitHub README generator
Produce a root `README.md` that a maintainer would sign off on: short, scannable,
trustworthy, and grounded entirely in what the repository actually contains.
The README is a landing page, not a copy of the documentation. It should carry a
reader from "what is this" to "first successful use" quickly, then hand off to
deeper docs and contributor information.
## When to use
Use for: creating a new root README, rewriting or refreshing an existing one,
filling in missing installation / usage / configuration / project links, or
auditing a README (and fixing it when the user asks for the fix).
Do not use for: full documentation sites or API references, authoring
`CONTRIBUTING.md` / `SECURITY.md` / `CHANGELOG.md` / licenses unless ordered
separately, marketing pages, release notes, general copywriting, or any change
to production code, configuration, or tests.
## Core constraints
1. **Repository first, prose second.** Never write a sentence before reading the
sources that back it. The examples must be this package's own domain — the
call it exists to make — not filler that would fit any project.
2. **Zero invention.** Any command, flag, env var, config key, public symbol,
version, badge, link, author, license, or support claim that cannot be traced
to the repository is omitted — not guessed. See `references/evidence-policy.md`.
3. **Conditional sections, nothing padded.** A section without verified content
is dropped — no empty heading