mirror of
https://github.com/MatMoul/g810-led.git
synced 2024-12-23 01:06:11 +00:00
Merge pull request #107 from simon-wh/develop
Fixed spelling and grammar in the README and INSTALL md files
This commit is contained in:
commit
92e656d199
13
INSTALL.md
13
INSTALL.md
@ -11,11 +11,11 @@
|
|||||||
## hidapi vs libusb :</br>
|
## hidapi vs libusb :</br>
|
||||||
hidapi is a newer implementation but needs more testing.</br>
|
hidapi is a newer implementation but needs more testing.</br>
|
||||||
hidapi is more responsive than libusb (~20ms vs ~150ms).</br>
|
hidapi is more responsive than libusb (~20ms vs ~150ms).</br>
|
||||||
hidapi seem not work on CentOS, writing on hidraw is not allowed.</br>
|
hidapi seems to not work on CentOS, writing to hidraw is not allowed.</br>
|
||||||
hidapi is recommended but if you encounter problem on your system, switch to libusb.</br>
|
hidapi is recommended but if you encounter a problem on your system, switch to libusb.</br>
|
||||||
|
|
||||||
|
|
||||||
## Installation by repos :</br>
|
## Installation using repos :</br>
|
||||||
ArchLinux (aur) :</br>
|
ArchLinux (aur) :</br>
|
||||||
`yaourt -S g810-led-git` # with yaourt</br>
|
`yaourt -S g810-led-git` # with yaourt</br>
|
||||||
`pacaur -S g810-led-git` # with pacaur</br>
|
`pacaur -S g810-led-git` # with pacaur</br>
|
||||||
@ -39,7 +39,7 @@ Fedora :</br>
|
|||||||
`make bin LIB=libusb` # for libusb</br>
|
`make bin LIB=libusb` # for libusb</br>
|
||||||
`sudo make install`</br>
|
`sudo make install`</br>
|
||||||
|
|
||||||
## Installation of the library (For developpers) :</br>
|
## Installation of the library (For developers) :</br>
|
||||||
`make lib` # for hidapi</br>
|
`make lib` # for hidapi</br>
|
||||||
`make lib LIB=libusb` # for libusb</br>
|
`make lib LIB=libusb` # for libusb</br>
|
||||||
`sudo make install-lib` to install the libg810-led library.</br>
|
`sudo make install-lib` to install the libg810-led library.</br>
|
||||||
@ -53,8 +53,7 @@ Same as install, but your profile and reboot files are preserved.</br>
|
|||||||
|
|
||||||
## Boot profiles :</br>
|
## Boot profiles :</br>
|
||||||
On boot, the keyboard is set with the udev file /etc/udev/rules.d/g810-led.rules</br>
|
On boot, the keyboard is set with the udev file /etc/udev/rules.d/g810-led.rules</br>
|
||||||
This file launch the profile stored in /etc/g810-led/profile</br>
|
This file launches the profile stored in /etc/g810-led/profile</br>
|
||||||
To prevent your keyboard to flash 3 time when you reboot, a systemd unit (g810-led-reboot) is available for this.</br>
|
To prevent your keyboard flashing 3 times when you reboot use the systemd unit (g810-led-reboot).</br>
|
||||||
It launch the profile stored in /etc/g810-led/reboot</br>
|
|
||||||
|
|
||||||
Samples can be found in /etc/g810-led/samples.</br>
|
Samples can be found in /etc/g810-led/samples.</br>
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# g810-led</br>
|
# g810-led</br>
|
||||||
|
|
||||||
Linux led controller for Logitech G213, G410, g413, G610, G810, G910 and GPRO Keyboards.</br>
|
Linux led controller for Logitech G213, G410, G413, G610, G810, G910 and GPRO Keyboards.</br>
|
||||||
|
|
||||||
## Compatible keyboards :</br>
|
## Compatible keyboards :</br>
|
||||||
- **G213 Prodigy**</br>
|
- **G213 Prodigy**</br>
|
||||||
@ -54,12 +54,12 @@ Linux led controller for Logitech G213, G410, g413, G610, G810, G910 and GPRO Ke
|
|||||||
`g810-led -kn d ff0000 # Set color of a key with no action`</br>
|
`g810-led -kn d ff0000 # Set color of a key with no action`</br>
|
||||||
`g810-led -c # Commit all changes`</br>
|
`g810-led -c # Commit all changes`</br>
|
||||||
|
|
||||||
## Samples for g610 :</br>
|
## Samples for G610 :</br>
|
||||||
`g610-led -a 60 # Set intensity of all keys`</br>
|
`g610-led -a 60 # Set intensity of all keys`</br>
|
||||||
`g610-led -k logo ff # Set intensity of a key`</br>
|
`g610-led -k logo ff # Set intensity of a key`</br>
|
||||||
`g610-led -g fkeys aa # Set intensity of a group of keys`</br>
|
`g610-led -g fkeys aa # Set intensity of a group of keys`</br>
|
||||||
|
|
||||||
## Samples for g213 :</br>
|
## Samples for G213 :</br>
|
||||||
`g213-led -a 00ff00 # Set all keys green`</br>
|
`g213-led -a 00ff00 # Set all keys green`</br>
|
||||||
`g213-led -r 1 ff0000 # Set region 1 red`</br>
|
`g213-led -r 1 ff0000 # Set region 1 red`</br>
|
||||||
|
|
||||||
@ -68,7 +68,7 @@ Linux led controller for Logitech G213, G410, g413, G610, G810, G910 and GPRO Ke
|
|||||||
`echo -e "k w ff0000\nk a ff0000\nk s ff0000\nk d ff0000\nc" | g810-led -pp # Set multiple keys`</br>
|
`echo -e "k w ff0000\nk a ff0000\nk s ff0000\nk d ff0000\nc" | g810-led -pp # Set multiple keys`</br>
|
||||||
|
|
||||||
## Testing unsuported keyboards :</br>
|
## Testing unsuported keyboards :</br>
|
||||||
Start by retrieve the VendorID and the ProductID of your keyboard with lsusb.</br>
|
Start by retrieving the VendorID and the ProductID of your keyboard using lsusb.</br>
|
||||||
`lsusb`</br>
|
`lsusb`</br>
|
||||||
Sample return :<br>
|
Sample return :<br>
|
||||||
`Bus 001 Device 001: ID 046d:c331 Logitech, Inc.`</br>
|
`Bus 001 Device 001: ID 046d:c331 Logitech, Inc.`</br>
|
||||||
|
Loading…
Reference in New Issue
Block a user