repository-readme-writer

Installation
SKILL.md

Repository README Writer

Create or improve repository READMEs that help humans and agents understand the project quickly without overfitting to fragile implementation details.

Decision Tree

What kind of README work is this?

  • Creating a new README from a repository Read references/repository-audit.md, then use templates/repository-readme.md.

  • Improving an existing README Read references/rewrite-patterns.md, then preserve useful sections and remove stale or overly specific material.

  • Fixing only the setup path Read references/quickstart-design.md and make the quickstart the shortest verified path from clone to useful local feedback.

  • Reviewing README quality without editing yet Run python3 scripts/repo_readme_probe.py <repo> and use templates/readme-review.md.

Installs
26
GitHub Stars
14
First Seen
May 20, 2026
repository-readme-writer — jpcaparas/skills