Zakaria
32 lines
667 B
Markdown
32 lines
667 B
Markdown
# {{PROJECT_NAME}}
|
|
|
|
{{ONE_PARAGRAPH_DESCRIPTION}}
|
|
|
|
## Key Concepts
|
|
|
|
- **{{CONCEPT_1}}** — {{ONE_LINE}}
|
|
- **{{CONCEPT_2}}** — {{ONE_LINE}}
|
|
- **{{CONCEPT_3}}** — {{ONE_LINE}}
|
|
|
|
## Entry Points
|
|
|
|
- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
|
|
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}
|
|
|
|
## High-Level Architecture
|
|
|
|
{{TWO_TO_THREE_SENTENCES}}
|
|
|
|
See [architecture.md](architecture.md) for the full picture.
|
|
|
|
## Module Map
|
|
|
|
| Module | Purpose |
|
|
|---|---|
|
|
| [`{{MODULE_1}}`](modules/{{MODULE_1}}.md) | {{ONE_LINE_PURPOSE}} |
|
|
| [`{{MODULE_2}}`](modules/{{MODULE_2}}.md) | {{ONE_LINE_PURPOSE}} |
|
|
|
|
## Getting Started
|
|
|
|
See [getting-started.md](getting-started.md).
|