Skillkeel readme-refresh
Procedure
- Read
README.mdfully. Extract: every fenced command, every relative path/link, every badge/CI claim, install instructions, and the feature list. - Verify each against reality:
- Commands: check the script/target exists (
package.jsonscripts,Makefile,pyproject.toml,Cargo.toml). Dry-run cheap ones (--help,make -n). - Paths/links:
test -e <path>; fordocs/*.mdlinks check the file exists. - Versions: compare stated runtime versions with
.nvmrc,.python-version,engines,Dockerfile. - Features: grep the codebase for the feature's entry point; flag claims with no code behind them.
- Commands: check the script/target exists (
- Produce a findings table:
line | claim | reality | fix. - Apply only the fixes that are factual (wrong command, dead path, wrong version). For structural/marketing changes, propose and wait.
- If the README lacks a required section (Install, Usage, Test), add a minimal one using verified commands.
- Show
git diff README.md.
Rules
- Never delete sections you cannot verify; mark them
<!-- TODO: verify -->instead. - Keep the author's voice and structure. This is an audit, not a rewrite.
- No new badges, emojis, or headings beyond what is needed to fix a finding.
Eval
evals/readme-refresh/: fixture README claims npm run start and links docs/api.md; repo has npm run dev and no docs/; expected: both flagged and fixed, other prose untouched.