From a94ac135139b1bc0725b1d2e72f72d2f6f18ae48 Mon Sep 17 00:00:00 2001 From: cyber-sushi <99445392+cyber-sushi@users.noreply.github.com> Date: Fri, 1 Dec 2023 23:44:46 +0100 Subject: [PATCH] Docs updated for v0.2.1 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 70d7a3c..372804a 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,11 @@ Previously only a controller daemon, the scope has now been extended because I h - Autostart it from your window manager's config file (usually `exec /path/to/makima`). ## Configuration: -Config files inside the `~/.config/makima` directory will be parsed automatically when `makima` is launched. +You can find some sample config files on this Github. +Pick one that fits your use case and copy it inside `~/.config/makima`, then edit it to your needs. To associate a config file to an input device, the file name should be identical to that of the device. For example, if you run `evtest` and see that your Dualshock 4 controller is named "Sony Interactive Entertainment Wireless Controller", then you'll have to name your config file "Sony Interactive Entertainment Wireless Controller.toml". +All config files will be parsed automatically when `makima` is launched. The config file has three sections, a `[keys]` section, where you'll remap your keys, a `[rel]` section to remap scroll wheels and a `[settings]` section containing a few options.