diff --git a/README.md b/README.md index a3d9584..e4d0226 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ -# smol_gkos +# smol GKOS controller -firmware for a small gkos keyboard + trackball \ No newline at end of file +![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) +A keyboard + mouse based on the [GKOS chording system](http://gkos.com/gkos/gkos-charset.html) with six Kailh Choc mechanical switches on the back, four mouse buttons on the front (left, right, middle mouse button + scrolling), three indicator LEDs, and a [blackberry-style Pimoroni trackball](https://shop.pimoroni.com/products/trackball-breakout), powered by a [Teensy 3.2 microcontroller](https://www.pjrc.com/store/teensy32.html). + +*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.* + +i'll write the rest tomorrow =w= diff --git a/doc/gkos.jpg b/doc/gkos.jpg new file mode 100644 index 0000000..2d6d8da Binary files /dev/null and b/doc/gkos.jpg differ