From eeefa30b0a2e7d88217354236ece4cfa421d1b6f Mon Sep 17 00:00:00 2001 From: Leonardo Ventura Date: Tue, 1 Sep 2020 10:56:53 -0300 Subject: [PATCH 1/2] docs: Update config example to match hidpp20 name --- logid.example.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/logid.example.cfg b/logid.example.cfg index 391281ab..e49d7b56 100644 --- a/logid.example.cfg +++ b/logid.example.cfg @@ -1,6 +1,6 @@ devices: ( { - name: "MX Master"; + name: "Wireless Mouse MX Master"; smartshift: { on: true; From 0614f27c621dd012e11cc84f122d784a692105c1 Mon Sep 17 00:00:00 2001 From: Leonardo Ventura Date: Tue, 1 Sep 2020 10:58:08 -0300 Subject: [PATCH 2/2] docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fad1f82b..062cd45e 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ This is currently only compatible with HID++ \>2.0 devices. ## Configuration [Refer to the wiki for details.](https://github.com/PixlOne/logiops/wiki/Configuration) -You may also refer to logid.example.cfg for an example. +You may also refer to [logid.example.cfg](./logid.example.cfg) for an example. -Default location for the configuration file is /etc/logid.cfg. +Default location for the configuration file is /etc/logid.cfg, but another can be specified using the `-c` flag. ## Dependencies -This project requires a C++14 compiler, cmake, libevdev, libudev, and libconfig. For popular distributions, I've included commands below. +This project requires a C++14 compiler, `cmake`, `libevdev`, `libudev`, and `libconfig`. For popular distributions, I've included commands below. **Debian/Ubuntu:** `sudo apt install cmake libevdev-dev libudev-dev libconfig++-dev` @@ -23,14 +23,14 @@ This project requires a C++14 compiler, cmake, libevdev, libudev, and libconfig. To build this project, run: -``` +```bash mkdir build cd build cmake .. make ``` -To install, run `sudo make install` after building. You can set the daemon to start at boot by running `sudo systemctl start logid`. +To install, run `sudo make install` after building. You can set the daemon to start at boot by running `sudo systemctl enable logid` or `sudo systemctl enable --now logid` if you want to enable and start the daemon. ## Donate This program is (and will always be) provided free of charge. If you would like to support the development of this project by donating, you can donate to my Ko-Fi below.