mirrors/clevo-keyboard
mirrors/clevo-keyboard
1
0
Fork 0
mirror of https://github.com/wessel-novacustom/clevo-keyboard.git synced 2024-11-15 03:34:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Steven Seifried 2019-10-15 21:59:30 +02:00
parent d65e76e84c
commit a79d39f980
No known key found for this signature in database
GPG key ID: 174371A9356D63E5
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -8,7 +8,7 @@
- <a href="#modes">Modes</a> - <a href="#modes">Modes</a>
# Description <a name="description"></a> # Description <a name="description"></a>
TUXEDO Computers Kernel module for keyboard backlighting. TUXEDO Computers Kernel Module for keyboard backlighting.
Additions Additions
- Sysfs interface to control the brightness, mode, color, on/off state - Sysfs interface to control the brightness, mode, color, on/off state
@ -18,7 +18,7 @@ Additions
# Building and Install <a name="building"></a> # Building and Install <a name="building"></a>
## Dependencies ## Dependencies:
- make - make
- gcc - gcc
- linux-headers - linux-headers
@ -32,13 +32,13 @@ This is why the DKMS build step begins with a `make clean` step.
For convenience, on platforms where DKMS is in use, skip to the DKMS section directly. For convenience, on platforms where DKMS is in use, skip to the DKMS section directly.
## Clone Git Repo ## Clone the Git Repo:
```sh ```sh
git clone https://github.com/tuxedocomputers/tuxedo-keyboard.git git clone https://github.com/tuxedocomputers/tuxedo-keyboard.git
``` ```
## Build the Module ## Build the Module:
```sh ```sh
cd tuxedo-keyboard cd tuxedo-keyboard
@ -50,7 +50,7 @@ make clean && make
### Add as DKMS Module: ### Add as DKMS Module:
At first point add the Module Add the Module:
```sh ```sh
make clean make clean
@ -59,30 +59,31 @@ sudo cp -R . /usr/src/tuxedo_keyboard-2
sudo dkms add -m tuxedo_keyboard -v 2 sudo dkms add -m tuxedo_keyboard -v 2
``` ```
The secound step is compile the module Compile the Module:
```sh ```sh
sudo dkms build -m tuxedo_keyboard -v 2 sudo dkms build -m tuxedo_keyboard -v 2
``` ```
Install the DKMS module Install the DKMS Module:
```sh ```sh
sudo dkms install -m tuxedo_keyboard -v 2 sudo dkms install -m tuxedo_keyboard -v 2
``` ```
Load the module with modprobe Load the Module with modprobe:
```sh ```sh
modprobe tuxedo_keyboard modprobe tuxedo_keyboard
``` ```
or
```sh
sudo modprobe tuxedo_keyboard
```
### Uninstalling the DKMS Module: ### Uninstalling the DKMS Module:
Remove the dkms module Remove the DKMS Module and Source:
```sh ```sh
sudo dkms remove -m tuxedo_keyboard -v 2 --all sudo dkms remove -m tuxedo_keyboard -v 2 --all
```
Remove the source
```sh
sudo rm -rf /usr/src/tuxedo_keyboard-2 sudo rm -rf /usr/src/tuxedo_keyboard-2
``` ```
@ -94,7 +95,7 @@ sudo rm -rf /usr/src/tuxedo_keyboard-2
modprobe tuxedo_keyboard modprobe tuxedo_keyboard
``` ```
## Load the module on boot: ## Load the Module on boot:
Add Module to /etc/modules Add Module to /etc/modules
```sh ```sh
@ -113,7 +114,7 @@ In this example, we start the kernel module with the following settings:
- green color for the center of keyboard - green color for the center of keyboard
- blue color for the right side of keyboard - blue color for the right side of keyboard
Note that we write its' settings to a `.conf` file under `/etc/modprobe.d` named `tuxedo_keyboard.conf`. Note that we write it's settings to a `.conf` file under `/etc/modprobe.d` named `tuxedo_keyboard.conf`.
```sh ```sh
sudo su sudo su