]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/sixkeyboard/readme.md
[Keyboard] Fix XD96 info.json (#6309)
[qmk_firmware.git] / keyboards / sixkeyboard / readme.md
index 7d78a0cae56b2f43a44459723653ca57651e6ca6..6979e1d48c1b34c0f5482f46df585d4753b2bdbf 100644 (file)
@@ -1,6 +1,17 @@
-# Techkeys SixKeyBoard
+Techkeys SixKeyBoard
+===
 
-[Get one here!](http://techkeys.us/collections/accessories/products/sixkeyboard)
+Keyboard Maintainer: QMK Community  
+Hardware Supported: Techkeys SixKeyBoard PCB  
+Hardware Availability: [Techkeys](http://techkeys.us/collections/accessories/products/sixkeyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make sixkeyboard:default
+
+See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+
+## Hardware Info
 
 The schematic is like this:
 
@@ -15,4 +26,4 @@ The schematic is like this:
 
 The LED on the bottom is `C4`. All 7 of the leds are turned on when the keyboard boots-up in the `sixkeyboard.c` file - backlight_enable is not required. The MCU is an Atmega16u2, so the flash memory is limited to 0x3000 bytes - the current setup uses just about all of that! I'm sure things can be opitimised a bit.
 
-There is a jumper on the bottom of the board (next to the USB port) that serves as a reset button - I drilled a hole in my case to allow for quick access via a screwdriver/metal object.
\ No newline at end of file
+There is a jumper on the bottom of the board (next to the USB port) that serves as a reset button - I drilled a hole in my case to allow for quick access via a screwdriver/metal object.