From 92ca477fc646b4a7f37bcce49b3d9127f9f070e0 Mon Sep 17 00:00:00 2001 From: TheNotary Date: Thu, 12 Sep 2024 15:21:23 -0500 Subject: [PATCH] renames workflow and adds build badge --- .../{hosted-ninja-vcpkg_submod.yml => windows.yml} | 0 README.md | 6 ++++-- 2 files changed, 4 insertions(+), 2 deletions(-) rename .github/workflows/{hosted-ninja-vcpkg_submod.yml => windows.yml} (100%) diff --git a/.github/workflows/hosted-ninja-vcpkg_submod.yml b/.github/workflows/windows.yml similarity index 100% rename from .github/workflows/hosted-ninja-vcpkg_submod.yml rename to .github/workflows/windows.yml diff --git a/README.md b/README.md index 20aeaac..e961abd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # XVX S-K80 Keyboard Driver for LED Control -> Warning: One keeb was lost during the development of this driver. XVX S-K80 and company (Womier seems to be an alternate name) does not ship with a very robust firmware and has open vulnerabilities that allow any non-root program on your computer to permenently destroy the device. If your computer emmits the wrong packets to the keyboard, it could actually brick the device. While this repo should be safe for S-K80's produced between 2023 and 2024, but knowing the issues with firmware released by this company, I recommend using this repo (and their official drivers for that matter) only if you're willing to accept the risk of losing the device. +[![windows](https://github.com/TheNotary/keyboard_driver_sk80/actions/workflows/windows.yml/badge.svg)](https://github.com/TheNotary/keyboard_driver_sk80/actions/workflows/windows.yml) -This project builds `blink.dll` a userspace driver that can control the LEDs on an XVX S-K80 mechanical keyboard. It happens to also support the RK84 by Royal Kludge. +> Warning: One keeb was lost during the development of this driver. XVX S-K80 and company (Womier seems to be an alternate name) does not ship with a very robust firmware and has open vulnerabilities that allow any non-root program on your computer to permenently destroy the device. If your computer emmits the wrong packets to the keyboard, it could actually brick the device. While this repo should be safe for S-K80's produced between 2023 and 2024, but knowing the issues with firmware released by this company, I recommend using this repo (and their official drivers for that matter) only if you're willing to accept the risk of losing the device. + +This project builds `blink.dll` a userspace driver that can control the LEDs on an XVX S-K80 mechanical keyboard. It happens to also support the RK84 by Royal Kludge. To communicate with the keyboard, this project leverages the Windows API, meaning it shouldn't require any installation to be run on a windows machine, but also won't work for linux. Please leave either a note or a PR if you'd like linux supported.