Skip to content

Commit

Permalink
trys the linter one more time
Browse files Browse the repository at this point in the history
  • Loading branch information
TheNotary committed Sep 12, 2024
1 parent a7ae9c4 commit f39d00b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/hosted-ninja-vcpkg_submod.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

name: hosted-ninja-vcpkg_submod-autocache
on:
push:
Expand All @@ -14,7 +13,7 @@ on:
env:
# Path to the CMake build directory.
build: '${{ github.workspace }}'
config: 'release-config'
config: 'Release'

jobs:
build:
Expand Down
9 changes: 5 additions & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ add_executable(main "src/demo/main.cpp"
"src/demo/blink_loader.cpp" "src/demo/blink_loader.h"
"src/demo/activities/push_to_light.cpp" "src/demo/activities/push_to_light.h"
"src/demo/activities/cycle_keyids.cpp" "src/demo/activities/cycle_keyids.h"
"include/main/misc.h" "src/demo/choose_keyboard.cpp" "src/demo/choose_keyboard.h"
"src/demo/choose_activity.cpp" "src/demo/choose_activity.h"
"src/demo/util.cpp" "src/demo/util.h"
"include/main/misc.h" "src/demo/choose_keyboard.cpp" "src/demo/choose_keyboard.h"
"src/demo/choose_activity.cpp" "src/demo/choose_activity.h"
"src/demo/util.cpp" "src/demo/util.h"
"src/demo/activities/test_single_key.cpp" "src/demo/activities/test_single_key.h")
target_include_directories(main PRIVATE "${CMAKE_SOURCE_DIR}/src/demo")

Expand All @@ -32,7 +32,7 @@ add_library(blink SHARED
"src/blink/keyboard.cpp" "include/main/keyboard.h"
"include/main/keyboards/abstract_keyboard.h"
"include/main/keyboards/sk80/sk80.h"

"include/main/keyboards/sk80/constants_sk80.h" "include/main/keyboards/sk80/messages_sk80.h" "include/main/keyboards/sk80/key_mappings_sk80.h"
"include/main/keyboards/rk84/constants_rk84.h"
"src/blink/keyboards/rk84/rk84.cpp" "include/main/keyboards/rk84/rk84.h"
Expand Down Expand Up @@ -72,3 +72,4 @@ target_compile_definitions(blink PRIVATE BUILD_DLL)
find_package(benchmark CONFIG REQUIRED)
add_executable(KeyboardBenchmark "benchmark/rk84_benchmark.cpp")
target_link_libraries(KeyboardBenchmark PRIVATE benchmark::benchmark benchmark::benchmark_main)

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# XVX S-K80 Keyboard Driver for LED Control

> Disclaimer: XVX S-K80 and company (womier seems to be an alternate name) does not ship with very good firmware and has open vulnerabilities that allow any non-root program on your computer permenently destroy the device. If your computer emmits the wrong packets to the keyboard, it could actually brick the device. This repo is safe for S-k80's produced between 2023 and 2024 but knowing the issues with firmware released by this company, I don't recommend testing this repo (or their official drivers for that matter) unless you're willing to risk the device.
> 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 a note if you'd like linux supported.
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.


#### Building on Terminal ("Developer Command Prompt")
Expand Down

0 comments on commit f39d00b

Please sign in to comment.