touches up readme

TheNotary · Sep 10, 2024 · 6c511e4 · 6c511e4
1 parent f8fb547
commit 6c511e4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
 # XVX S-K80 Keyboard Driver for LED Control
 
-This project builds an exe that can control the LEDs on an XVX S-K80 mechanical keyboard.  As that the project also demonstrates sourcing dependencies in a C++ project via vcpkg and CMake and that this is a new area of study for me, you'll find detailed steps on setting up windows-based C++ package management below.
+> 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.  
 
-This project uses the Windows API for interacting with USB, 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.
+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.
 
 
 #### Building on Terminal ("Developer Command Prompt")
 
 To conduct the build and execute the tests, at the root of the repo, run:
 ```
-test.bat
+setup.bat
 ```
 
-More note available [here](docs/env_setup_and_building.md).
+For more notes about vcpkg, CMake, and doing the build on a windows-based C++ environment see [here](docs/env_setup_and_building.md).
diff --git a/docs/env_setup_and_building.md b/docs/env_setup_and_building.md
@@ -18,7 +18,7 @@ set PATH=%VCPKG_ROOT%;%PATH%
 
 vcpkg install
 
-# As a shortcut, run test.bat
+# As a shortcut, run setup.bat
 cmake --preset release-config
 cmake --build --preset release-build --target clean
 cmake --build --preset release-build

diff --git a/test.bat → setup.bat b/test.bat → setup.bat