Raw view: README From a Codebase
No invisible, zero-width, or bidi-control characters detected.
Write a README for the repository described below. Every command, path, and claim in the README must be traceable to the inputs. A README that invents an `npm start` script the project does not have is worse than no README, because the first thing a new contributor does is run it.
<repository>
<purpose>{{PROJECT_PURPOSE}}</purpose>
<file_tree>
{{FILE_TREE}}
</file_tree>
<manifest>
{{MANIFEST}}
</manifest>
<entry_points>
{{ENTRY_POINTS}}
</entry_points>
<existing_docs>
{{EXISTING_DOCS}}
</existing_docs>
</repository>
<manifest> is the package/build file (package.json, pyproject.toml, Cargo.toml, go.mod, Makefile, etc.). <entry_points> holds the main source files or CLI definitions. <existing_docs> may include an old README, CONTRIBUTING, or docstrings; reuse accurate parts and drop stale ones. <purpose> may be empty; if so, infer it from the code and mark the sentence `[inferred]`.
Rules:
1. Before writing, list the facts you can establish from the inputs: language and version, package manager, scripts/targets and what they run, required environment variables (grep for `env`, `getenv`, `process.env`), external services the code connects to, test framework, and license file presence. Only these facts may appear in the README.
2. The first screen must answer three questions in order: what is this, who is it for, and how do I run it in under five commands. Everything else goes below.
3. Quote install, run, and test commands exactly as the manifest defines them. If a command needs a prerequisite (a database, a token), state it immediately above the command.
4. Where a section the README needs cannot be filled from the inputs (deployment, architecture decisions, support channels), write the heading with a one-line `TODO(owner): ...` describing exactly what to add. Do not fill gaps with plausible-sounding prose.
5. Match the project's own vocabulary from the code and <existing_docs>. If the code calls it a "workspace", the README does too.
6. Keep it scannable: short paragraphs, fenced code blocks for every command, one table at most. Target 80-150 lines of Markdown; a README is a map, not the territory.
## Output format
Produce the README as a single Markdown document with this structure (omit a heading only if the inputs make it inapplicable, and say so in the facts list):
```
# Project name
One-sentence purpose. [inferred] if applicable.
## Quick start (prerequisites, install, run, verify it worked)
## What it does (3-6 sentences or bullets; the user's view, not the code's)
## Usage (the primary commands/API with one example each)
## Configuration (table: variable, required?, default, purpose)
## Development (setup, test command, lint/format, project layout in 5-10 lines)
## Deployment (or TODO)
## Contributing (link to CONTRIBUTING.md if present, else TODO)
## License (from LICENSE file if present, else TODO)
```
After the README, add for the maintainer:
**Facts used** - the list from step 1, each with the file it came from.
**Could not determine** - what you looked for and did not find, so the maintainer knows which TODOs are real gaps vs missing inputs.