Skip to content

Commit 882ebc9

Browse files
committed
Update project metadata
1 parent 4dbbe13 commit 882ebc9

File tree

3 files changed

+24
-14
lines changed

3 files changed

+24
-14
lines changed

README.md

+18-12
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Minimal Linux distro CLI & UI for TUXEDO / Clevo computers Keyboard Backlight
33

44
This utility automates toggling keyboard backlight state for Tuxedo/ Clevo computers on Linux.
5-
It can toggle the keyboard backlight off, set any modes defined [here](https://github.com/tuxedocomputers/tuxedo-keyboard#modes) and set a single-color subset from the `custom` mode.
5+
It can toggle the keyboard backlight off, set any modes defined [here](https://github.com/tuxedocomputers/tuxedo-keyboard#modes) and set a single or multiple colors in `custom` mode.
66
Available colors can be found [here](https://www.cssportal.com/html-colors/orig-16-colors.php).
77

88
## Usage
@@ -21,26 +21,32 @@ backlight <command> [<option>]
2121

2222
```
2323
Usage:
24-
-h, --help Display this message
24+
-h, --help Display this message
2525
26-
ui Start the Tuxedo Backlight Control UI
26+
ui Start the Tuxedo Backlight Control UI
2727
28-
off Turn off keyboard backlight
28+
off Turn off keyboard backlight
2929
30-
<mode> Set the keyboard backlight to <mode>, one of:
31-
breathe, cycle, dance, flash, random, tempo, wave
30+
<mode> Set the keyboard backlight to <mode>, one of:
31+
breathe, cycle, dance, flash, random, tempo, wave
3232
33-
color Set the keyboard backlight to a single color, one of:
34-
white, silver, gray, yellow, orange, red, maroon, crimson,
35-
fuchsia, purple, rose, cyan, turquoise, teal, blue, navy,
36-
olive, lime, green
33+
color <color>{1,4} Set the keyboard backlight to a single color, one of:
34+
white, silver, gray, yellow, orange, red, maroon, crimson,
35+
fuchsia, purple, rose, cyan, turquoise, teal, blue, navy,
36+
olive, lime, green
37+
38+
Alternatively, set the keyboard to x (1-4) distinct colors,
39+
in the order: left, center, right, extra. Only regions supported
40+
by your keyboard will have effect.
3741
3842
```
3943

4044
## Requirements
4145

42-
You need bash for the CLI (pre-installed on most Linux distros) and python3 and python3-tk for the GUI.
43-
You also need the [tuxedo-keyboard](https://github.com/tuxedocomputers/tuxedo-keyboard) module installed.
46+
Required packages: python3, python3-tk & policykit-1.
47+
On Debian you can verify if you have these by doing `apt show <package-name>`.
48+
49+
Required modules: [tuxedo-keyboard](https://github.com/tuxedocomputers/tuxedo-keyboard)
4450
Download it from the repository or git clone as below:
4551

4652
```

assets/screenshot.png

11.5 KB
Loading

src/DEBIAN/control

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
Source: tuxedo-backlight-control
22
Package: tuxedo-backlight-control
3-
Version: 0.2
3+
Version: 0.3
4+
Standards-Version: 0.3
45
Maintainer: Kevin Van Lierde
56
Architecture: all
67
Description: Tuxedo Backlight Control
78
This utility is built on top of TUXEDO Computers Kernel module for keyboard backlighting: (https://github.com/tuxedocomputers/tuxedo-keyboard) for Debian-based systems.
89
It provides a bash CLI and a minimal Python UI.
910
Section: utils/contrib
1011
Priority: optional
11-
Recommends: python3, python3-tk, polkit-1
12+
Depends: python3, python3-tk, policykit-1
1213
Installed-Size: 52
14+
Package-Type: deb
15+
Vcs-Browser: https://github.com/webketje/tuxedo-backlight-control
16+
Vcs-Git: https://github.com/webketje/tuxedo-backlight-control.git

0 commit comments

Comments
 (0)