← ClaudeAtlas

github-readme-writerlisted

Writes or rewrites a repository's README in a professional, structured register that anyone opening the repository for the first time can act on: every file inventoried, every command run for real output, screenshots or diagrams produced when missing, 10-14 sections chosen from a 38-row menu, then a second review against eleven acceptance criteria (CHALLENGER.md) and a checker (lint.py) that rejects eight mechanical AI tells. Use when asked for a README or when one "shows nothing".
rishabhrawat35/github-readme-writer · ★ 2 · Code & Development · score 63
Install: claude install-skill rishabhrawat35/github-readme-writer
# GitHub README Writer **Version 1.1.0** · 1.0.0 is the commit that introduced R1 to R9 and A1 to A10. Keep this in step with the account skill's description, which is the only version the desktop app shows. Bump patch for wording, minor for a new rule or criterion, major for a change to the seven steps. This skill produces a README that a first-time visitor can act on without opening the code, in seven numbered steps. ## Ground rules 1. **Every file is read before any prose is written.** Vendored and generated folders, binaries and secret files are listed without being read; a README that omits a feature is wrong, not short. 2. **Nothing unverified appears in the README.** Every command shown was run, every output shown is what it printed, and every path, count and claim was checked during this run. 3. **The reader is anyone opening the repository for the first time.** The audience is narrowed only when the repository is built for one group alone, and the README states why. 4. **The section menu in Step 5 is a menu, not a checklist.** A typical tool uses 10 to 14 of its 38 rows. 5. **The ten writing rules in Step 6 each carry a test and a fails/passes pair.** 6. **No secret is leaked and nothing is destroyed.** Only variable names from `.env.example` or the code appear in the README; an existing README is copied to `README.prev.md` before it is overwritten; nothing that deploys, publishes, pushes, deletes or spends money is run. ## Step 1 — Inventory every file in the r