summaryrefslogtreecommitdiffstats
path: root/keyboards/hfdkb/keyboard_sw/k83/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/hfdkb/keyboard_sw/k83/readme.md')
-rw-r--r--keyboards/hfdkb/keyboard_sw/k83/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/hfdkb/keyboard_sw/k83/readme.md b/keyboards/hfdkb/keyboard_sw/k83/readme.md
new file mode 100644
index 0000000000..871e9b8936
--- /dev/null
+++ b/keyboards/hfdkb/keyboard_sw/k83/readme.md
@@ -0,0 +1,18 @@
+# k83
+
+A customizable 75% encoder keyboard.
+
+* Keyboard Maintainer: [jonylee@hfd](https://github.com/jonylee1986)
+* Hardware Supported: k83
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hfdkb/keyboard_sw/k83:default
+
+Flashing example for this keyboard:
+
+ make hfdkb/keyboard_sw/k83:default:flash
+
+**Reset Key**: Hold down the key located at *K01*, which programmed as *Esc* while plugging in the keyboard.
+
+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).