Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
Instalação
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
when_to_use
publishing a repo, onboarding docs, "is the README good"
targets
["*"]
README Audit
A README's only job: a stranger clones it and gets to "it works" without asking you.
Check, in order:
One sentence on what it is and who it's for - above the fold.
Install - copy-paste commands that actually work on a clean machine. Test them mentally step by step.
Run / quickstart - the smallest end-to-end example.
Config - required env vars, where secrets go.
No rot - does it reference files/commands/flags that still exist? Stale README is worse than none.
Cut: long philosophy, badges nobody reads, TODO sections. Output: the specific gaps + the fix.