summaryrefslogtreecommitdiff
path: root/keyboards/shk9/readme.md
diff options
context:
space:
mode:
authorSam Hudson <samsamm777@users.noreply.github.com>2021-02-05 11:31:15 +0000
committerGitHub <noreply@github.com>2021-02-05 03:31:15 -0800
commit18babeae49dc933f7a07e123241ae2a78a75f168 (patch)
tree733e4f51eb0b6e45abfe3346c007ca8a07ef1cb8 /keyboards/shk9/readme.md
parent59bf018e9fb50f20400d012f09558ad4ffe6d4a4 (diff)
[Keyboard] add shk9 macropad (#11505)
* added shk9 macropad * updated readme * removed json file * updated config * removed commented config * fixed website address * added bootloader mode info to readme * remove midi enable rule * fixed comment * fixed default keymap * changed layout to ortho * fixed typo * fixed broken layout * pr changes * added keymap spacing
Diffstat (limited to 'keyboards/shk9/readme.md')
-rw-r--r--keyboards/shk9/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/shk9/readme.md b/keyboards/shk9/readme.md
new file mode 100644
index 0000000000..1fab42a1ac
--- /dev/null
+++ b/keyboards/shk9/readme.md
@@ -0,0 +1,23 @@
+# shk9
+
+![shk9](https://i.imgur.com/FluRgiHl.jpg)
+
+The SHK9 is a tiny 3x3 macropad! Fully configurable with via.
+
+* Keyboard Maintainer: [Sam Hudson](https://github.com/samsamm777)
+* Hardware Supported: SHK9 PCB (ATmega32u4)
+* Hardware Availability: http://superhuman.website
+
+Make example for this keyboard (after setting up your build environment):
+
+ make shk9:default
+
+Flashing example for this keyboard:
+
+ make shk9:default:flash
+
+## Bootloader Mode
+
+To reset the board into bootloader mode, remove the pcb from the case buy removing keycaps, and unscrewing the 3 screws. Then (while plugged in) press the switch on the underside of the PCB for a few seconds. The board is now in bootloader mode.
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). \ No newline at end of file