55 lines (38 loc) · 964 Bytes

[Project Name]

[One sentence: what this project does and who it helps.]

Why It Exists

[Describe the problem, user, or opportunity in plain language.]

Quick Start

[install command]
[run command]

What You Can Do

[Capability 1]
[Capability 2]
[Capability 3]

Project Structure

/
|-- src/        [purpose]
|-- docs/       [purpose]
|-- tests/      [purpose]
\-- scripts/    [purpose]

Common Commands

Task	Command
Install	`[command]`
Develop	`[command]`
Test	`[command]`
Build	`[command]`

Documentation

SETUP.md for local setup.
ARCHITECTURE.md for system design.
ROADMAP.md for planned work.
CHANGELOG.md for notable changes.
CONTRIBUTING.md for collaboration.

Status

[Prototype / active development / stable / maintenance mode]

License

[License name]