change(README): Added installation instructions

This commit is contained in:
2025-08-05 23:25:48 +02:00
parent 0ea1174fae
commit fb4e3db827

View File

@@ -2,6 +2,18 @@
This software allows mapping and translating of MIDI commands to HID inputs on Linux.
## Installation and Usage
Install with
```bash
go install git.datalore.sh/datalore/midi-hid@latest
```
and run it with `midi-hid`. It reads `config.yaml` from its current working directory, creates the configured virtual gamepads and translates the inputs until SIGINT is received.
See the provided example config on how to configure your controller, it should be pretty self-explanatory.
## Known issues
The midi library used seems to recognise NoteOff messages as NoteOn messages. However, they can still be recognised by checking the velocity, which is always 0 in NoteOff messages. A workaround has been implemented.