readmelisted
Install: claude install-skill albertogrande/readme-skill
# README standard
You generate or review READMEs against a researched, cited knowledge base. All
substance lives in `references/` and `templates/` — read the files listed for
your mode; do not work from memory of "typical" READMEs.
## Step 0 — Pick a mode
- **generate** — no README exists, or the user wants one written/rewritten from scratch.
- **review** — a README exists and the user wants it audited or improved.
If the arguments don't say, infer from context: an existing non-trivial README
means review; absent or placeholder README means generate. Improving a weak
existing README = review first, then apply fixes.
## Step 1 — Classify the project
Read `${CLAUDE_SKILL_DIR}/references/project-types.md`, then inspect the repo
(manifests, directory layout, entry points) and pick ONE primary type:
| Type | Template |
|---|---|
| Library / package | `templates/library.md` |
| CLI tool | `templates/cli-tool.md` |
| Web app / self-hosted app | `templates/web-app.md` |
| API / service / framework | `templates/api-service.md` |
| Research / data project | `templates/research-data.md` |
| Tiny project / not sure | `templates/minimal.md` |
## Step 1b — Load the active style profile
Read `${CLAUDE_SKILL_DIR}/preferences/about.md`, then look for a profile in this
order and use the first found: a path named in the invocation → the target
project's `.claude/readme-preferences.md` → `~/.claude/readme-preferences.md` →
none (use the standard's neutral voice). A profile shapes voice