aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/sixkeyboard
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-08-16 15:08:16 -0700
committerJack Humbert <jack.humb@gmail.com>2017-08-16 20:36:59 -0400
commit4e73b0b8d7750bcddc445b5a52008d4c6cea977d (patch)
treee6c54f5d0b334f1e0acc41b6406e8b26900f80b0 /keyboards/sixkeyboard
parent2ee0dc7793165eacfe7ee2a4994d557294988f18 (diff)
downloadfirmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.gz
firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.tar.bz2
firmware-4e73b0b8d7750bcddc445b5a52008d4c6cea977d.zip
Make the bulk of our keyboards match the readme.md standard
Diffstat (limited to 'keyboards/sixkeyboard')
-rw-r--r--keyboards/sixkeyboard/readme.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/keyboards/sixkeyboard/readme.md b/keyboards/sixkeyboard/readme.md
index 7d78a0cae..a2fc9eb46 100644
--- 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.