logiops/README.md

# logiops

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 for an example.

Default location for the configuration file is /etc/logid.cfg.

## Dependencies

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`

**Arch Linux:** `sudo pacman -S cmake libevdev libconfig libudev`

## Building

To build this project, run:

```
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`.

## 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.

<a href='https://ko-fi.com/R6R81QQ9M' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

I'm also looking for contributors to help in my project; feel free to submit a pull request or e-mail me if you would like to contribute.

## Compatible Devices

[For a list of tested devices, check TESTED.md](TESTED.md)

## Special Thanks
Thanks to the following people for contributing to this repository.

- [Clément Vuchener & contributors for creating the old HID++ library](https://github.com/cvuchener/hidpp)
- [Developers of Solaar for providing information on HID++](https://github.com/pwr-Solaar/Solaar)
- [Nestor Lopez Casado for providing Logitech documentation on the HID++ protocol](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)
- Everyone listed in the contributors page
Major refactoring, transferring from masterd 2019-07-17 05:53:51 +00:00			`# logiops`

			`This is an unofficial driver for Logitech mice and keyboard.`

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

Add config info in README 2019-07-30 02:56:20 +00:00			`## 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.`

Indicate DEFAULT_CONFIG_FILE location While fairly self-evident, would be helpful to mention to users where their logid.cfg is meant to go. This just adds one sentence to achieve just that. 2020-07-07 03:27:47 +00:00			`Default location for the configuration file is /etc/logid.cfg.`

Added dependencies for Debian and Arch 2020-06-15 09:47:03 +00:00			`## Dependencies`

Add note about state of branch in README.md 2020-06-16 23:56:27 +00:00			`This project requires a C++14 compiler, cmake, libevdev, libudev, and libconfig. For popular distributions, I've included commands below.`
Added dependencies for Debian and Arch 2020-06-15 09:47:03 +00:00
			Debian/Ubuntu: `sudo apt install cmake libevdev-dev libudev-dev libconfig++-dev`
Major refactoring, transferring from masterd 2019-07-17 05:53:51 +00:00
Added dependencies for Debian and Arch 2020-06-15 09:47:03 +00:00			Arch Linux: `sudo pacman -S cmake libevdev libconfig libudev`

			`## Building`
Major refactoring, transferring from masterd 2019-07-17 05:53:51 +00:00
			`To build this project, run:`

			```
			`mkdir build`
			`cd build`
			`cmake ..`
			`make`
			```

Add logid service & install target 2019-08-09 18:25:40 +00:00			To install, run `sudo make install` after building. You can set the daemon to start at boot by running `sudo systemctl start logid`.
Major refactoring, transferring from masterd 2019-07-17 05:53:51 +00:00
Added donate button to README.md 2020-06-15 07:31:36 +00:00			`## 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.`

			`<a href='https://ko-fi.com/R6R81QQ9M' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://cdn.ko-fi.com/cdn/kofi1.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>`

			`I'm also looking for contributors to help in my project; feel free to submit a pull request or e-mail me if you would like to contribute.`

Major refactoring, transferring from masterd 2019-07-17 05:53:51 +00:00			`## Compatible Devices`

Move tested devices to TESTED.md 2020-06-21 19:45:50 +00:00			`[For a list of tested devices, check TESTED.md](TESTED.md)`
Add thanks to README.md 2020-07-02 21:37:28 +00:00
			`## Special Thanks`
			`Thanks to the following people for contributing to this repository.`

			`- [Clément Vuchener & contributors for creating the old HID++ library](https://github.com/cvuchener/hidpp)`
			`- [Developers of Solaar for providing information on HID++](https://github.com/pwr-Solaar/Solaar)`
			`- [Nestor Lopez Casado for providing Logitech documentation on the HID++ protocol](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)`
			`- Everyone listed in the contributors page`