README Generator

Write README files that feel intentional. Minimal is the default. Prefer a small number of strong sections, short paragraphs, and GitHub-native formatting used with restraint.

Working Pass

1. Inspect the repository before writing. Read the manifest, scripts, entrypoints, test setup, existing docs, and any current README material. Do not invent commands, features, or support claims.
2. Decide the shape from the product type. Libraries need install and usage. Apps need setup, run, and visual context. CLIs need commands and examples. Internal tools can stay shorter.
3. Build the smallest complete README. The default shape is a centered title block, one short summary paragraph, and only the install or usage material a reader actually needs.
4. Compress the draft. Remove generic feature dumps, redundant headings, and sections that only repeat what the file tree already says.

Default Length

Aim for the shortest README that still lets a new reader understand the project and start using it. Most repos only need a title, one paragraph, one command block, and one usage example.

Expand only when a reader would otherwise be blocked, confused, or likely to misuse the project.

House Style