change(README): Added installation instructions

housekeeping: Updated module name
2025-08-05 23:25:48 +02:00 · 2025-08-05 23:25:35 +02:00
2 changed files with 13 additions and 1 deletions
--- 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.
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module datalore/midi-hid
+module git.datalore.sh/datalore/midi-hid

 go 1.24.5
Author	SHA1	Message	Date
datalore	fb4e3db827	change(README): Added installation instructions	2025-08-05 23:25:48 +02:00
datalore	0ea1174fae	housekeeping: Updated module name	2025-08-05 23:25:35 +02:00