BuboBubo/Cagire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Feat: documentation, UI/UX

Browse Source
This commit is contained in:
Raphaël Forment
2026-03-01 19:09:52 +01:00
parent ecb559e556
commit db44f9b98e
57 changed files with 1531 additions and 615 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/getting-started/staging.md
View File

@@ -1,18 +1,27 @@
# Stage / Commit
Cagire requires you to `stage` changes you wish to make to the playback state and then `commit` it. It is way more simple than it seems. For instance, you mark pattern `04` and `05` to start playing, and _then_ you send the order to start the playback (`commit`). The same goes for stopping patterns. You mark which pattern to stop (`stage`) and then you give the order to stop them (`commit`). Why is staging useful? Here are some reasons why this design choice was made:
In Cagire, changes to playback happen in two steps. First you **stage**: you mark what you want to happen. Then you **commit**: you apply all staged changes at once. Nothing changes until you commit. It is simpler than it sounds.
- **To apply multiple changes**: Queue several patterns to start/stop, commit them together.
- **To get clean timing**: All changes happen on beat/bar boundaries.
- **To help with live performance**: Prepare the next section without affecting current playback.
Say you want patterns `04` and `05` to start playing together. You stage both (`p` on each), then commit (`c`). Both start at the same time. Want to stop them later? Stage them again, commit again. That's it.
This two-step process exists for good reasons:
- **Multiple changes at once**: queue several patterns to start/stop, commit them together.
- **Clean timing**: all changes land on beat or bar boundaries, never mid-step.
- **Safe preparation**: set up the next section while the current one keeps playing.
## Push changes, then apply
Staging is an essential feature to understand to be effective when doing live performances:
1. Open the **Patterns** view (`F2` or `Ctrl+Up` from sequencer)
2. Navigate to a pattern you wish to change/play
3. Press `p` to stage it. The pending change is going to be displayed:
- `+` (staged to play)
- `+` (staged to play)
- `-` (staged to stop)
- `m` (staged to mute)
- `s` (staged to solo)
- etc.
4. Repeat for other patterns you want to change
5. Press `c` to commit all changes
6. Or press `Esc` to cancel
@@ -24,7 +33,8 @@ You can also stage mute/solo changes:
- 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.
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