Zakaria
48 lines
658 B
Markdown
48 lines
658 B
Markdown
# Getting Started
|
|
|
|
## Prerequisites
|
|
|
|
- {{LANGUAGE_RUNTIME_VERSION}}
|
|
- {{DEPENDENCY}}
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
{{INSTALL_COMMANDS}}
|
|
```
|
|
|
|
## First Run
|
|
|
|
```bash
|
|
{{FIRST_RUN_COMMAND}}
|
|
```
|
|
|
|
You should see {{EXPECTED_OUTPUT}}.
|
|
|
|
## Common Workflows
|
|
|
|
### {{WORKFLOW_1}}
|
|
|
|
```bash
|
|
{{COMMANDS}}
|
|
```
|
|
|
|
### {{WORKFLOW_2}}
|
|
|
|
```bash
|
|
{{COMMANDS}}
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Key config files and settings:
|
|
|
|
- `{{CONFIG_FILE}}` — {{WHAT_IT_CONTROLS}}
|
|
- Env var `{{VAR}}` — {{WHAT_IT_CONTROLS}}
|
|
|
|
## Where to Go Next
|
|
|
|
- Architecture overview: [architecture.md](architecture.md)
|
|
- Module reference: [README.md#module-map](README.md#module-map)
|
|
- Diagrams: [diagrams/](diagrams/)
|