awesome-readme

Installation
SKILL.md

Awesome README

Workflow

  1. Run python3 scripts/inspect_project.py --root <repository> --target <README-path>.

  2. Read each source cited by the tool. This includes rules, manifests, and the current README. Trust project rules and manifests before old prose.

  3. Classify visibility and project type on their own. Read repository modes. Load only the other guides that fit the task.

  4. Make an evidence ledger. Track claims, commands, links, reader paths, owners, and gaps. Mark each command as declared at first.

  5. Resolve gaps that change the section set. Ask all such questions in one batch. Ask the exact visibility question from the modes guide when needed.

  6. Create or revise the file from the ledger. Omit minor facts that are still unknown. Do not leave blanks or sample text.

  7. Infer the category, reader, job, value, proof, voice, and next step. Use product-marketing first when it is present. For new public work, use copywriting next. Always use copy-editing and then humanizer. Use the linked checks when those skills are absent.

  8. Run the prose check with the project root and README path. Fix each error and run it again. Check local links. Run safe commands when you can.

Installs
2
First Seen
Aug 7, 2026
awesome-readme — tjboudreaux/cc-skills-awesome-readme