Feat: documentation

This commit is contained in:
2026-02-16 23:19:06 +01:00
parent 773c7bbd1c
commit 540f59dcf5
18 changed files with 565 additions and 227 deletions

View File

@@ -8,15 +8,22 @@ Cagire requires you to `stage` changes you wish to make to the playback state an
Staging is an essential feature to understand to be effective when doing live performances:
1. Open the **Patterns** view (`Ctrl+Up` from sequencer)
1. Open the **Patterns** view (`F2` or `Ctrl+Up` from sequencer)
2. Navigate to a pattern you wish to change/play
3. Press `Space` to stage it. The pending change is going to be displayed:
3. Press `p` to stage it. The pending change is going to be displayed:
- `+` (staged to play)
- `-` (staged to stop)
4. Repeat for other patterns you want to change
5. Press `c` to commit all changes
6. Or press `Esc` to cancel
You can also stage mute/solo changes:
- Press `m` to stage a mute toggle
- Press `x` to stage a solo toggle
- Press `Shift+m` to clear all mutes
- Press `Shift+x` to clear all solos
A pattern might not start immediately depending on the sync mode you have chosen. It might wait for the next beat/bar boundary.
## Status Indicators
@@ -26,8 +33,10 @@ A pattern might not start immediately depending on the sync mode you have chosen
| `>` | Currently playing |
| `+` | Staged to play |
| `-` | Staged to stop |
| `M` | Muted |
| `S` | Soloed |
A pattern can show both `>` (playing) and `-` (staged to stop).
A pattern can show combined indicators, e.g. `>` (playing) and `-` (staged to stop), or `>M` (playing and muted).
## Quantization