Readme Audit
Documentsreadme-auditReadme Audit is an Agent Skill for documents published in the Archive228/loopkit repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Check whether a README actually lets a stranger run the project. Use on any repo's README before publishing.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/Archive228/loopkit/blob/HEAD/skills/readme-audit/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/readme-audit, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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.