Skip to content

Commit 11cc01a

Browse files
committed
Improve README.md
- add uninstall instructions - move "configuration" section after "install"
1 parent 990f923 commit 11cc01a

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

+38-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ This is an unofficial driver for Logitech mice and keyboard.
44

55
This is currently only compatible with HID++ \>2.0 devices.
66

7-
## Configuration
8-
[Refer to the wiki for details.](https://github.com/PixlOne/logiops/wiki/Configuration)
9-
10-
You may also refer to [logid.example.cfg](./logid.example.cfg) for an example.
11-
12-
Default location for the configuration file is /etc/logid.cfg, but another can be specified using the `-c` flag.
13-
147
## Dependencies
158

169
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
2518

2619
**Solus:** `sudo eopkg install libevdev-devel libconfig-devel libgudev-devel`
2720

28-
## Building
21+
## How to build
2922

3023
To build this project, run:
3124

@@ -36,7 +29,43 @@ cmake ..
3629
make
3730
```
3831

39-
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.
32+
## How to install
33+
34+
To install after building, run:
35+
36+
```bash
37+
sudo make install
38+
```
39+
40+
Finally, enable and start the daemon:
41+
42+
```bash
43+
sudo systemctl enable --now logid
44+
```
45+
46+
## How to configure
47+
48+
Default location for the configuration file is /etc/logid.cfg, but another can be specified using the `-c` flag.
49+
50+
[Refer to the wiki for details.](https://github.com/PixlOne/logiops/wiki/Configuration)
51+
52+
You may also refer to [logid.example.cfg](./logid.example.cfg) for an example.
53+
54+
55+
## How to uninstall
56+
57+
First, disable the daemon:
58+
```bash
59+
sudo systemctl disable --now logid
60+
```
61+
62+
Then remove the few files that were installed:
63+
```bash
64+
sudo rm /usr/local/bin/logid
65+
sudo rm /lib/systemd/system/logid.service
66+
sudo rm /etc/logid.cfg
67+
```
68+
4069

4170
## Donate
4271
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.

0 commit comments

Comments
 (0)