diff --git a/README.md b/README.md index 5e72913..74cd096 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # smol GKOS controller -A compact 6-button keyboard based on the [GKOS chording system](http://gkos.com/gkos/gkos-charset.html) with a small blackberry-style trackball mouse. +A compact 6-button keyboard based on the [GKOS chording system](http://gkos.com) with a small blackberry-style trackball mouse. I wanted a combined keyboard + mouse to plug into a single USB port (simpler for USB OTG, and less wires to wrangle around) for controlling single board computers like Raspberry Pis, media PCs etc. I also wanted to try if the GKOS layout would be practical for use in terminal environments as well as more general use. + ![a mint green 3d printed wedge shaped controller with four pink mouse buttons on one side and six white keycapped mechanical switches in two columns on the other](doc/gkos.jpg) ***Please note that I don't recommend you build one of these as-is, as there are quite a few improvements I'd like to make in a second version in the future (detailed below). It is a usable device, but it's up here more as a resource and less a ready-to-go thing to build.*** @@ -13,9 +14,10 @@ I wanted a combined keyboard + mouse to plug into a single USB port (simpler for - short countersunk M2 screws and nuts - three 3mm LEDs + 51k resistors (will vary depending on the specific LEDs) - M2x3.5x8mm heat set inserts +- 3D printed case parts **(see the case/ folder for documentation!)** ### Layout changes and additions -The keyboard layout follows the official GKOS character set fairly closely, but has a few changes made for use with desktop computers. +The keyboard layout follows [the official GKOS character set](http://gkos.com/gkos/gkos-charset.html) fairly closely, but has a few changes made for use with desktop computers. - an additional function key layer (similar to how the symbol set works), activated with the chord ACDE (in terms of the six physical keys pressed on their own) - F1-F10 mapped to the same places as the number keys, F11 = L/@, F12 = M/½ - print screen = delete