diff --git a/README.md b/README.md index 7626910..57f5530 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,33 @@ It runs on Windows, Mac, and Linux. ## Usage -_Note: This is a CLI program, but see below for GUI. It's advisable to use the official software if you're on Windows / Mac._ +> This is a CLI program, but see below for GUI. It's advisable to use the official software if you're on Windows / Mac. -_Note: On Linux you will need to run it as super user [(issue with hidraw?)](https://github.com/pixeltris/GK6X/issues/3). It can be compiled / ran with mono on Linux / Mac ([see #4](https://github.com/pixeltris/GK6X/issues/4)). On Windows you compile it with Visual Studio._ +### Compilation + +It can be compiled / ran with mono on Linux / Mac ([see #4](https://github.com/pixeltris/GK6X/issues/4)). On Windows you compile it with Visual Studio. + +### Linux + +On Linux you will need to run it as super-user (with `sudo`) or udev can be used to give yourself permissions to the raw-hid device. See [(issue with hidraw?)](https://github.com/pixeltris/GK6X/issues/3). + +I made a udev rule file that looks like this, in `/etc/udev/rules.d/gk6x.rules`: + +``` +SUBSYSTEM=="input", GROUP="input", MODE="0666" +SUBSYSTEM=="usb", ATTRS{idVendor}=="1ea7", ATTRS{idProduct}=="0907", MODE:="666", GROUP="plugdev" +KERNEL=="hidraw*", ATTRS{idVendor}=="1ea7", ATTRS{idProduct}=="0907", MODE="0666", GROUP="plugdev" +``` + +I added myself to `plugdev` (then rebooted): + +```sh +sudo adduser $(whoami) plugdev +``` + +You will need to reboot to make the udev rules & group take effect. + +### General When you open the program it will connect to your keyboard (there's no console output until it finds something to connect to). @@ -18,13 +42,13 @@ You can reprogram the base layer and layers 1-3 (and the Fn keys). The 'driver' ![Alt text](https://raw.githubusercontent.com/pixeltris/GK6X/master/Screenshot.png) -## Usage (Web GUI) +### Web GUI There's some very basic (and mostly untested) support for a web GUI by using the official software's web component. Use the 'gui' command to start the web server (it should automatically open the web page at http://127.0.0.1:6464). -_Note: This repo doesn't contain the web files. Copy and paste the official software's folder into the "Build" folder, or use the pre-bundled version on the [releases](https://github.com/pixeltris/GK6X/releases) page._ +> This repo doesn't contain the web files. Copy and paste the official software's folder into the "Build" folder, or use the pre-bundled version on the [releases](https://github.com/pixeltris/GK6X/releases) page. -_Note: The GUI isn't capable of remapping keys on the base layer. Changes to the JavaScript would be required to get this working_ +> The GUI isn't capable of remapping keys on the base layer. Changes to the JavaScript would be required to get this working ![Alt text](https://raw.githubusercontent.com/pixeltris/GK6X/master/ScreenshotWeb.png)