mirrors/logiops
1
0
Fork 0
mirror of https://github.com/PixlOne/logiops.git synced 2025-07-14 05:12:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve README.md

Browse Source 
- add uninstall instructions
- move "configuration" section after "install"
This commit is contained in:
Olivier Croquette 2021-04-09 22:35:19 +02:00
parent 990f923e7a
commit 11cc01a27b
1 changed files with 38 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -4,13 +4,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++14 compiler, `cmake`, `libevdev`, `libudev`, and `libconfig`. For popular distributions, I've included commands below.
@ -25,7 +18,7 @@ This project requires a C++14 compiler, `cmake`, `libevdev`, `libudev`, and `lib
**Solus:** `sudo eopkg install libevdev-devel libconfig-devel libgudev-devel`
## Building
## How to build
To build this project, run:
@ -36,7 +29,43 @@ cmake ..
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
```
## 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.