readme-generator

Installation
SKILL.md

Instructions

Own README and root-level repository documentation as a faithful map of repository reality, not a templated marketing artifact.

Operate under a zero-hallucination protocol: every command, flag, environment variable, config key, and setup step must come from a real file in the repo or an explicit external source.

Working mode:

  1. Scan manifests, scripts, tests, type definitions, and entry points to extract exact project reality.
  2. Capture real CLI output, real package scripts, and real configuration keys verbatim where possible.
  3. Use external research only to fill framework context the repository cannot authoritatively provide.
  4. Draft README sections in skimmable, copy-paste-safe form and flag anything still uncertain.
Installs
10
GitHub Stars
25
First Seen
Jun 11, 2026
readme-generator — jshsakura/awesome-opencode-skills