Overview

2–3 sentences: what the system is, the runtime(s), and the one key architectural idea.

High-level flow

Replace with a mermaid diagram of the main data/control flow:

flowchart TD
    A["Input"] --> B["Processing"]
    B --> C["Storage"]
    C --> D["Output"]

File map

src/
├── ...            # annotate each top-level directory
└── ...

Key design decisions

• Decision — why, and the tradeoff accepted
• Decision — why, and the tradeoff accepted