Use when writing or updating a project's README from its actual code structure.
Preview full content
Write or update this project's README by actually reading its code structure first, not by guessing from the project name:
- What it does: one or two sentences, plain language, no marketing tone.
- Quickstart: the minimum commands to install and run it — verify these against the actual package.json/Makefile/entry point rather than assuming a convention.
- Configuration: only the settings/env vars a new user actually needs to know about to get started, not an exhaustive dump of every option.
- One real example: an actual usage example that would work if copy-pasted, not pseudocode.
Leave out sections that don't apply to this project rather than including a boilerplate "Contributing"/"License" section with no real content. If something about how to run or configure the project is genuinely unclear from the code, say so explicitly rather than writing a confident-sounding instruction you're not sure is correct.