Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #230

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README.md #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 38 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:

Expand All @@ -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.
Expand Down