From 0c3c0f1977c623adc2218aece5544f45e20f3548 Mon Sep 17 00:00:00 2001 From: Wessel klein Snakenborg <100232604+wessel-novacustom@users.noreply.github.com> Date: Tue, 12 Sep 2023 13:39:23 +0200 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 9db36bc..4a3799b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ +# The change we made + +General Clevo compatibility: Regular Clevo laptops do not have modified UEFI firmware variables like the manufacturer name. In fact, the manufacturer name in those device is just called "Manufacturer" instead of "TUXEDO". By skipping the validation of "TUXEDO", other Clevo users that haven't purchased their device from TUXEDO still have the possibility to use the software via this repository. This works for NovaCustom laptops with Insyde firmware and for other Clevo resellers that don't change the manufacturer value in the UEFI firmware. + +Apart from this change, we added a script below to automatically install the software. Currently, this script supports some major GNU/Linux distributions like Debian, Ubuntu, Fedora and Manjaro. + +## Automated installation + +To install the software automatically, open a terminal and execute: + +```sh +wget https://novacustom.com/vendorfirmware/kb.sh && chmod +x kb.sh && sudo ./kb.sh +``` + +After the installation, reboot the laptop in order to make the application work. You might want to clean up the installation files with the following command: + +```sh +sudo rm -rf ~/tuxedo-keyboard/ && rm ~/kb.sh +``` + +## A special note for Dasharo coreboot firmware users + +Dasharo coreboot firmware users that already have the keyboard backlight control included in the firmware don't need to and should not use this application. This also applies for users of other coreboot firmware distributions. + +# Original unchanged content below + # Table of Content - Description - Building and Install