From fb4e3db82799ae2d5e8de36300f2b9c4165ee89f Mon Sep 17 00:00:00 2001 From: datalore Date: Tue, 5 Aug 2025 23:25:48 +0200 Subject: [PATCH] change(README): Added installation instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 5abc018..86ebe2d 100644 --- a/README.md +++ b/README.md @@ -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.