diff --git a/README.md b/README.md index cedf0179..ed36d01d 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,6 @@ This is an unofficial driver for Logitech mice and keyboard. 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](./logid.example.cfg) for an example. - -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++20 compiler, `cmake`, `libevdev`, `libudev`, `glib`, and `libconfig`. @@ -30,7 +23,7 @@ For popular distributions, I've included commands below. **openSUSE:** `sudo zypper install cmake libevdev-devel systemd-devel libconfig-devel gcc-c++ libconfig++-devel libudev-devel glib2-devel` -## Building +## How to build To build this project, run: @@ -41,7 +34,43 @@ cmake -DCMAKE_BUILD_TYPE=Release .. make ``` -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. +## How to install + +To install after building, run: + +```bash +sudo make install +``` + +Finally, enable and start the daemon: + +```bash +sudo systemctl enable --now logid +``` + +## How to configure + +Default location for the configuration file is /etc/logid.cfg, but another can be specified using the `-c` flag. + +[Refer to the wiki for details.](https://github.com/PixlOne/logiops/wiki/Configuration) + +You may also refer to [logid.example.cfg](./logid.example.cfg) for an example. + + +## How to uninstall + +First, disable the daemon: +```bash +sudo systemctl disable --now logid +``` + +Then remove the few files that were installed: +```bash +sudo rm /usr/local/bin/logid +sudo rm /lib/systemd/system/logid.service +sudo rm /etc/logid.cfg +``` + ## Development