Skip to content

Commit

Permalink
Update project metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
webketje committed May 12, 2019
1 parent 4dbbe13 commit 882ebc9
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 14 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Minimal Linux distro CLI & UI for TUXEDO / Clevo computers Keyboard Backlight

This utility automates toggling keyboard backlight state for Tuxedo/ Clevo computers on Linux.
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.
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.
Available colors can be found [here](https://www.cssportal.com/html-colors/orig-16-colors.php).

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

```
Usage:
-h, --help Display this message
-h, --help Display this message
ui Start the Tuxedo Backlight Control UI
ui Start the Tuxedo Backlight Control UI
off Turn off keyboard backlight
off Turn off keyboard backlight
<mode> Set the keyboard backlight to <mode>, one of:
breathe, cycle, dance, flash, random, tempo, wave
<mode> Set the keyboard backlight to <mode>, one of:
breathe, cycle, dance, flash, random, tempo, wave
color Set the keyboard backlight to a single color, one of:
white, silver, gray, yellow, orange, red, maroon, crimson,
fuchsia, purple, rose, cyan, turquoise, teal, blue, navy,
olive, lime, green
color <color>{1,4} Set the keyboard backlight to a single color, one of:
white, silver, gray, yellow, orange, red, maroon, crimson,
fuchsia, purple, rose, cyan, turquoise, teal, blue, navy,
olive, lime, green
Alternatively, set the keyboard to x (1-4) distinct colors,
in the order: left, center, right, extra. Only regions supported
by your keyboard will have effect.
```

## Requirements

You need bash for the CLI (pre-installed on most Linux distros) and python3 and python3-tk for the GUI.
You also need the [tuxedo-keyboard](https://github.com/tuxedocomputers/tuxedo-keyboard) module installed.
Required packages: python3, python3-tk & policykit-1.
On Debian you can verify if you have these by doing `apt show <package-name>`.

Required modules: [tuxedo-keyboard](https://github.com/tuxedocomputers/tuxedo-keyboard)
Download it from the repository or git clone as below:

```
Expand Down
Binary file modified assets/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions src/DEBIAN/control
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
Source: tuxedo-backlight-control
Package: tuxedo-backlight-control
Version: 0.2
Version: 0.3
Standards-Version: 0.3
Maintainer: Kevin Van Lierde
Architecture: all
Description: Tuxedo Backlight Control
This utility is built on top of TUXEDO Computers Kernel module for keyboard backlighting: (https://github.com/tuxedocomputers/tuxedo-keyboard) for Debian-based systems.
It provides a bash CLI and a minimal Python UI.
Section: utils/contrib
Priority: optional
Recommends: python3, python3-tk, polkit-1
Depends: python3, python3-tk, policykit-1
Installed-Size: 52
Package-Type: deb
Vcs-Browser: https://github.com/webketje/tuxedo-backlight-control
Vcs-Git: https://github.com/webketje/tuxedo-backlight-control.git

0 comments on commit 882ebc9

Please sign in to comment.