Writing Readmes

Write, overhaul or review a repo's front-door README.md. The first screen says what the project is and who it is for, the quickstart is proven by a cold run, and reference material moves to docs. Use for "write the README", "fix the README", "review the README", "the readme isn't clear", or a README that has grown into a docs dump.

smarzban Updated

File contents

smarzban/agent-skills commit 387324ef33

Frequently asked questions

npx get-skill add smarzban/writing-readmes