repository-readme-writer

Installation
SKILL.md

Repository README writer

Inspect before writing: a README that guesses commands, package managers, ports or deployment shape is worse than none. Inspect only what the requested scope needs; a wording or link review does not require the probe or a setup audit.

Evidence

python3 scripts/repo_readme_probe.py <repo> [--pretty] prints JSON of README, manifests, package scripts, package manager (from lockfiles), env examples, CI and similar signals. It finds files; it is evidence, not README content. Otherwise look at manifests and task runners, lockfiles, entrypoints, env examples, required services, test/lint/typecheck/build commands, CI and deployment config, and existing docs.

  • Manifest scripts and CI beat prose for commands; prefer the combined quality script if there is one. Lockfiles imply the package manager. Version manager files, manifests and CI are the version authority: state supported ranges, and repeat an exact pin only where it helps, linking its source of truth.
  • If you did not run a command, ground it in a manifest script or CI and say it is unverified, or label it a risk when reviewing. Do not invent a build system for a static or archived repo.

Writing

Installs
85
GitHub Stars
57
First Seen
May 20, 2026