several improvements for mitosis:datagrok (#1960)

[qmk_firmware.git] / keyboards / sixkeyboard / readme.md

diff --git a/keyboards/sixkeyboard/readme.md b/keyboards/sixkeyboard/readme.md
index 7d78a0cae56b2f43a44459723653ca57651e6ca6..c0d87bc2c5975924cf9ac01151527b43c6db1197 100644 (file)
--- a/keyboards/sixkeyboard/readme.md
+++ b/keyboards/sixkeyboard/readme.md
@@ -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: 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/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) 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.