README

Overview

Provide a high-level description of the project, its purpose, and expected outcome.

Audience

State who this project is for (for example: product team, platform team, external users).

Core Capabilities

• Capability 1:
• Capability 2:
• Capability 3:

Quickstart

1. Create env: python -m venv .venv
2. Activate: .venv\Scripts\Activate.ps1
3. Install: pip install -r requirements.txt
4. Run tests: pytest -q
5. Optional convenience scripts: .\scripts\setup.ps1 and .\scripts\test.ps1

Template Bootstrap Checklist

• Required docs exist at root (README.md, CONTEXT.md, ARCHITECTURE.md, SECURITY.md, STANDARDS.md, DECISIONS.md, ROADMAP.md, CHANGELOG.md, AGENTS.md).
• Scaffold directories exist (src/, tests/, prompts/, evals/, configs/, scripts/).
• Dependencies install successfully from requirements.txt.
• Lint passes: ruff check .
• Tests pass: pytest -q
• Roadmap and changelog are updated for initial project scope.

Documentation Map

• Context and goals: CONTEXT.md
• Architecture and data flow: ARCHITECTURE.md
• Security expectations: SECURITY.md
• Coding/testing/review standards: STANDARDS.md
• Decision history: DECISIONS.md
• Planned milestones: ROADMAP.md
• Release notes: CHANGELOG.md