zawz/rmidimap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: updat readme

Browse source
This commit is contained in:
zawz 2023-09-08 15:32:23 +02:00
parent e61163da88
commit a07cb828cc
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,7 +2,7 @@
Map MIDI signals to command with a simple yaml file. Map MIDI signals to command with a simple yaml file.
See [format]() and [examples](/examples/). See [format](/FORMAT.md) and [examples](/examples/).
# Usage # Usage
@ -14,14 +14,18 @@ Simply execute `rmidimap <FILE>` to start with the desired map file.
Only Linux+ALSA currently. Only Linux+ALSA currently.
### Device connection
Connect to devices by name, regex or address, and run commands on connect or disconnect.
### MIDI Event mapping
Define commands to execute on certain MIDI events
### Performance ### Performance
rmidimap runs with very low processing overhead. rmidimap runs with very low processing overhead.
Processing overhead has been measured at 100-200µs, while execution spawning was measured to 1-4ms. Processing overhead was measured at 100-200µs, while execution spawning was measured to 1-4ms.
### Device connection
Connect to devices by name or regex, and run commands on connect or disconnect.
### Command queue and interval ### Command queue and interval