dominic/atonatui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Dominic DiTaranto 2026-08-09 16:30:46 -04:00
parent a81212c461
commit b985581b74
1 changed files with 26 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -12,22 +12,35 @@ Features:
## Installation Guide ## Installation Guide
## Main Page
The main page consists of a 12 Tone Matrix.
The only part of the main page that really needs explaining is the tri-colored table below the matrix.
- The TONE row contains the tones of P0 row.
- RTHM is the rhythmic division assigned to a given note.
- OCTV is the octave assigned to a given note.
The rhythmic division and octave will always be the same for their associated note, the order just changes when you play a row other than P0.
When you do begin playback, this tri-colored table will be replaced with the row that is currently being played.
## Commands ## Commands
| Command | Action | Page | Notes | | Command | Action | Page |
|---|---|---|---| |---|---|---|
| `P0-P11` | Play Prime Row | Main Page | | | `P0-P11` | Play Prime Row | Main Page |
| `I0-I11` | Play Inversion Row | Main Page | | | `I0-I11` | Play Inversion Row | Main Page |
| `R0-R11` | Play Retrograde Row | Main Page | | | `R0-R11` | Play Retrograde Row | Main Page |
| `i0-i11` | Play Retrograde Inversion Row | Main Page | | | `i0-i11` | Play Retrograde Inversion Row | Main Page |
| `loop <count> <P0-i11>` | Play row X times in loop | Main Page | | | `loop <count> <P0-i11>` | Play row X times in loop | Main Page |
| `seq <P0-i11>,<P0-i11>... ` | Play sequence of rows, comma separated | Main Page | | | `seq <P0-i11>,<P0-i11>... ` | Play sequence of rows, comma separated | Main Page |
| `r` OR `regen` | Regenerate Matrix | Main Page | | | `r` OR `regen` | Regenerate Matrix | Main Page |
| `s` OR `settings` | Go To Settings Page | Main Page | | | `s` OR `settings` | Go To Settings Page | Main Page |
| `h` OR `help` | Open This Document | Main Page | | | `h` OR `help` | Open This Document | Main Page |
| `q` OR `quit` | Quit Application | Main Page, Settings Page | | | `q` OR `quit` | Quit Application | Main Page, Settings Page |
| Setting ID | Edit Setting | Settings Page | | | Setting ID | Edit Setting | Settings Page |
__Advanced Commands:__ __Advanced Commands:__
- Loop a sequence: - Loop a sequence: