Merge pull request #118 from Kaligule/patch-1

Readme: Quote values in markdown syntax
This commit is contained in:
tuxedoxt 2022-01-12 20:52:09 +01:00 committed by GitHub
commit 04efaee9e5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -127,38 +127,38 @@ sudo cp tuxedo_keyboard.conf /etc/modprobe.d/tuxedo_keyboard.conf
# Sysfs <a name="sysfs"></a> # Sysfs <a name="sysfs"></a>
## General ## General
Path: /sys/devices/platform/tuxedo_keyboard Path: `/sys/devices/platform/tuxedo_keyboard`
## color_left ## color_left
Allowed Values: Hex-Value (e.g. 0xFF0000 for the Color Red) Allowed Values: Hex-Value (e.g. `0xFF0000` for the Color Red)
Description: Set the color of the left Keyboard Side Description: Set the color of the left Keyboard Side
## color_center ## color_center
Allowed Values: Hex-Value (e.g. 0xFF0000 for the Color Red) Allowed Values: Hex-Value (e.g. `0xFF0000` for the Color Red)
Description: Set the color of the center of Keyboard Description: Set the color of the center of Keyboard
## color_right ## color_right
Allowed Values: Hex-Value (e.g. 0xFF0000 for the Color Red) Allowed Values: Hex-Value (e.g. `0xFF0000` for the Color Red)
Description: Set the color of the right Keyboard Side Description: Set the color of the right Keyboard Side
## color_extra ## color_extra
Allowed Values: Hex-Value (e.g. 0xFF0000 for the Color Red) Allowed Values: Hex-Value (e.g. `0xFF0000` for the Color Red)
Description: Set the color of the extra region (if exist) of the Keyboard Description: Set the color of the extra region (if exist) of the Keyboard
## brightness ## brightness
Allowed Values: 0 - 255 Allowed Values: `0` - `255`
Description: Set the brightness of the Keyboard Description: Set the brightness of the Keyboard
## mode ## mode
Allowed Values: 0 - 7 Allowed Values: `0` - `7`
Description: Set the mode of the Keyboard. A list with the modes is under <a href="#modes">Modes</a> Description: Set the mode of the Keyboard. A list with the modes is under <a href="#modes">Modes</a>
## state ## state
Allowed Values: 0, 1 Allowed Values: `0`, `1`
Description: Set the State of keyboard, 0 is keyboard is off and 1 is keyboard is on Description: Set the State of keyboard, `0` is keyboard is off and `1` is keyboard is on
## extra ## extra
Allowed Values: 0, 1 Allowed Values: `0`, `1`
Description: Only get the information, if the keyboard have the extra region Description: Only get the information, if the keyboard have the extra region
# Kernel Parameter <a name="kernelparam"></a> # Kernel Parameter <a name="kernelparam"></a>
@ -191,25 +191,25 @@ Set the brightness of keyboard
# Modes <a name="modes"></a> # Modes <a name="modes"></a>
## CUSTOM ## CUSTOM
Value: 0 Value: `0`
## BREATHE ## BREATHE
Value: 1 Value: `1`
## CYCLE ## CYCLE
Value: 2 Value: `2`
## DANCE ## DANCE
Value: 3 Value: `3`
## FLASH ## FLASH
Value: 4 Value: `4`
## RANDOM_COLOR ## RANDOM_COLOR
Value: 5 Value: `5`
## TEMPO ## TEMPO
Value: 6 Value: `6`
## WAVE ## WAVE
Value: 7 Value: `7`