Skip to content
Kitbay
Skill

readme-generator

MITUpdated on Nov 18, 2026147GitHub stars

A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details.

What the skill teaches

A skill for writing a new README.md or reorganising an existing one so a newcomer sees the pitch, the install step and one common example before the details. In a Git repository it first syncs with origin, stashing tracked changes, and stops to ask if that fails. It then reads the manifest, licence, changelog, docs, tests and command-line definitions to collect facts with their source, backs up the old README, and writes the opening section followed by detail sections in a set order, keeping every original section. A self-check covers order, traced commands, working links and filler text. Missing facts become placeholders, and nothing is committed unless asked.

Capabilities

  • Write a README from facts in the repository
  • Restructure an existing README without dropping sections
  • Back up the previous README before writing
  • Check commands and links in the result