Write some amount of documentation
This commit is contained in:
39
docs/navigation.md
Normal file
39
docs/navigation.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Navigation
|
||||
|
||||
The Cagire application is organized as a grid composed of six views:
|
||||
|
||||
```
|
||||
Dict Patterns Options
|
||||
Help Sequencer Engine
|
||||
```
|
||||
|
||||
- `Dict` (Dictionary): A comprehensive list of all the `Forth` words used in the application.
|
||||
- `Help`: Provides detailed information about the application's features and functionalities.
|
||||
- `Patterns`: Pattern banks and pattern manager. Used to organize a session / project.
|
||||
- `Sequencer`: The main view, where you edit sequences and play music.
|
||||
- `Options`: Configuration settings for the application.
|
||||
- `Engine`: Configuration settings for the internal audio engine.
|
||||
|
||||
## Switching Views
|
||||
|
||||
Use `Ctrl+Arrow` keys to move between views. A minimap appears briefly showing your position in the grid.
|
||||
|
||||
- `Ctrl+Left` / `Ctrl+Right` - move horizontally
|
||||
- `Ctrl+Up` / `Ctrl+Down` - move vertically
|
||||
|
||||
The grid wraps horizontally, so you can cycle through views on the same row.
|
||||
|
||||
## Getting Help
|
||||
|
||||
Press `?` on any view to see its keybindings. This shows all available shortcuts for the current context.
|
||||
|
||||
Press `Esc` to close the keybindings panel.
|
||||
|
||||
## Common Keys
|
||||
|
||||
These work on most views:
|
||||
|
||||
- `Arrow keys` - move or scroll
|
||||
- `Tab` - switch focus between panels
|
||||
- `/` or `Ctrl+f` - search (where available)
|
||||
- `q` - quit (with confirmation)
|
||||
Reference in New Issue
Block a user