Skip to main content

​
README Formatter

Generate or validate READMEs that follow the standard. READMEs should look the same across every repo. Badges in the right place. Title and tagline up top. A “Teach Your AI” block so new users know how to start. Features listed clearly. Interface coverage table. License at the bottom. README Formatter checks all of this. Or generates a new one from scratch.

​
What It Does

  • Validates existing READMEs against the WIP Computer standard
  • Generates new READMEs with the correct structure
  • Checks for: badges, title, tagline, “Teach Your AI” block, features, interface table, license
  • Reports what’s missing or out of place

​
Install

ldm install wipcomputer/wip-ai-devops-toolbox

​
Usage

wip-readme-format check          # validate current README
wip-readme-format generate       # create a new one

​
The Standard

Every README follows the same structure:
  1. Badges (npm version, license, etc.)
  2. Title and tagline
  3. “Teach Your AI” install block
  4. Features with interface labels
  5. Interface coverage table
  6. Technical documentation
  7. License
Consistent documentation across every repo. No guessing what goes where.

​
Interfaces

CLI, Skill.

​
Part of LDM OS

README Formatter is part of AI DevOps Toolbox, which installs into LDM OS.