Write some amount of documentation

This commit is contained in:
2026-01-31 01:46:18 +01:00
parent e1c4987db5
commit 8cd0ec92c0
57 changed files with 2096 additions and 198 deletions

51
docs/banks_patterns.md Normal file
View File

@@ -0,0 +1,51 @@
# Banks & Patterns
Cagire organizes all your patterns and data following a strict hierarchy:
- **Projects** contain **Banks**.
- **Banks** contain **Patterns**.
- **Patterns** contain **Steps**.
## Structure
```
Project
└── 32 Banks
└── 32 Patterns (per bank)
└── 128 Steps (per pattern)
```
A single project gives you 32 banks, each holding 32 patterns. You get 1024 patterns in each project, ~131.000 steps.
## Patterns
Each pattern is an independent sequence of steps with its own properties:
| Property | Description | Default |
|----------|-------------|---------|
| Length | Steps before the pattern loops (`1`-`128`) | `16` |
| Speed | Playback rate (`1/8x` to `8x`) | `1x` |
| Quantization | When the pattern launches | `Bar` |
| Sync Mode | Reset or Phase-Lock on re-trigger | `Reset` |
Press `e` in the patterns view to edit these settings.
## Patterns View
Access the patterns view with `Ctrl+Up` from the sequencer. The view shows all banks and patterns in a grid. Indicators show pattern state:
- `>` Currently playing
- `+` Staged to play
- `-` Staged to stop
### Keybindings
| Key | Action |
|-----|--------|
| `Arrows` | Navigate banks and patterns |
| `Enter` | Select and return to sequencer |
| `Space` | Toggle pattern playback |
| `e` | Edit pattern properties |
| `r` | Rename bank or pattern |
| `c` / `v` | Copy / Paste |
| `Delete` | Reset to empty pattern |