1
0
mirror of https://github.com/MatMoul/g810-led.git synced 2024-12-23 17:26:11 +00:00
g810-led/INSTALL.md

64 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2017-01-15 01:09:26 +00:00
# Installation :</br>
## Build dependencies :</br>
* git
* g++
* make
## Dependencies :</br>
2017-01-21 21:45:48 +00:00
* hidapi or libusb
## hidapi vs libusb :</br>
2017-04-04 22:25:38 +00:00
hidapi is a newer implementation but needs more testing.</br>
hidapi is more responsive than libusb (~20ms vs ~150ms).</br>
2017-01-21 21:45:48 +00:00
hidapi seem not work on CentOS, writing on hidraw is not allowed.</br>
hidapi is recommended but if you encounter problem on your system, switch to libusb.</br>
2017-01-15 01:09:26 +00:00
2017-01-26 01:49:15 +00:00
## Installation by repos :</br>
ArchLinux (aur) :</br>
`yaourt -S g810-led-git` # with yaourt</br>
`pacaur -S g810-led-git` # with pacaur</br>
2017-01-26 01:49:15 +00:00
2017-01-15 01:09:26 +00:00
## Installation of dependencies :</br>
ArchLinux :</br>
2017-01-21 22:00:07 +00:00
`sudo pacman -S git gcc make hidapi` # for hidapi</br>
`sudo pacman -S git gcc make libusb` # for libusb</br>
2017-01-15 01:09:26 +00:00
Debian :</br>
2017-01-21 22:00:07 +00:00
`sudo apt-get install git g++ make libhidapi-dev` # for hidapi</br>
`sudo apt-get install git g++ make libusb-1.0-0-dev` # for libusb</br>
2017-01-21 08:15:18 +00:00
Fedora :</br>
2017-01-21 22:00:07 +00:00
`sudo dnf install git make gcc-c++ hidapi-devel` # for hidapi</br>
`sudo dnf install git make gcc-c++ libusbx-devel` # for libusb</br>
2017-01-15 01:09:26 +00:00
## Installation :</br>
`git clone https://github.com/MatMoul/g810-led.git`</br>
`cd g810-led`</br>
2017-01-21 22:00:07 +00:00
`make` # for hidapi</br>
`make LIB=libusb` # for libusb</br>
2017-01-15 01:09:26 +00:00
`sudo make install`</br>
`make install-lib` to install the libg810-led library.</br>
`make install-dev` to install the libg810-led library and headers for development.</br>
## Building the library :</br>
The library is built by default when running the `make` (default target "all").</br>
To specifically build the library as a standalone component: </br>
`make lib`</br>
2017-01-15 01:09:26 +00:00
## Update :</br>
Same as install, but your profile and reboot files are preserved.</br>
## Uninstall :</br>
`sudo make uninstall`</br>
2017-01-15 01:10:50 +00:00
## Boot profiles :</br>
2017-01-21 21:45:48 +00:00
If your system use systemd, g810-led has 2 systemd units (g810-led and g810-led-reboot).</br>
2017-01-15 01:09:26 +00:00
These 2 units set the keyboard profile on boot and reboot.</br>
2017-01-21 21:45:48 +00:00
Profiles are stored in /etc/g810-led :</br>
* /etc/g810-led/profile
* /etc/g810-led/reboot
2017-01-21 22:00:07 +00:00
Samples can be found in /etc/g810-led/samples.</br>