tanner/logiops
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7462a11a5a
logiops/README.md

57 lines
2.3 KiB
Markdown
Raw Normal View History

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)
docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability.
2020-09-01 13:58:08 +00:00
You may also refer to [logid.example.cfg](./logid.example.cfg) for an example.
Add config info in README
2019-07-30 02:56:20 +00:00
docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability.
2020-09-01 13:58:08 +00:00
Default location for the configuration file is /etc/logid.cfg, but another can be specified using the `-c` flag.
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
Added dependencies for Debian and Arch
2020-06-15 09:47:03 +00:00
## Dependencies
docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability.
2020-09-01 13:58:08 +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
edit dependecies for arch linux
2020-07-19 05:56:47 +00:00
**Arch Linux:** `sudo pacman -S cmake libevdev libconfig pkgconf`
Added dependencies for Debian and Arch
2020-06-15 09:47:03 +00:00
package install instructions for Solus
2020-09-27 07:54:08 +00:00
**Solus:** `sudo eopkg install libevdev-devel libconfig-devel libgudev-devel`
Added Fedora dependancy install commands (#155) * Added Fedora 33 dependancy install commands Tested on a relatively fresh install of Fedora 33, gcc-c++ included as no c++ compiler by default, feel free to remove if it fits better with the pattern of not including one in the previous instructions, however it did trip me up for a few minutes so may be worth leaving in. * Remove Fedora Version * Update README.md Changed systemd-devel1 to systemd-devel (typo)
2021-01-07 23:38:12 +00:00
**Fedora:** `sudo dnf install cmake libevdev-devel systemd-devel libconfig-devel gcc-c++`
Added dependencies for Debian and Arch
2020-06-15 09:47:03 +00:00
## Building
Major refactoring, transferring from masterd
2019-07-17 05:53:51 +00:00
To build this project, run:
docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability.
2020-09-01 13:58:08 +00:00
```bash
Major refactoring, transferring from masterd
2019-07-17 05:53:51 +00:00
mkdir build
cd build
cmake ..
make
```
docs: Fix instruction to enable daemon Change `start` to `enable` on systemctl command instruction to enable daemon at boot. Also add instruction to enable and start at the same time. A few other minor improvements on readability.
2020-09-01 13:58:08 +00:00
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.
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
Reference in New Issue Copy Permalink