awesome-readme
Awesome README
Workflow
-
Run
python3 scripts/inspect_project.py --root <repository> --target <README-path>. -
Read each source cited by the tool. This includes rules, manifests, and the current README. Trust project rules and manifests before old prose.
-
Classify visibility and project type on their own. Read repository modes. Load only the other guides that fit the task.
-
Make an evidence ledger. Track claims, commands, links, reader paths, owners, and gaps. Mark each command as declared at first.
-
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.
-
Create or revise the file from the ledger. Omit minor facts that are still unknown. Do not leave blanks or sample text.
-
Infer the category, reader, job, value, proof, voice, and next step. Use
product-marketingfirst when it is present. For new public work, usecopywritingnext. Always usecopy-editingand thenhumanizer. Use the linked checks when those skills are absent. -
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.