summaryrefslogtreecommitdiff
path: root/keyboards/k34/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/k34/readme.md')
-rw-r--r--keyboards/k34/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/k34/readme.md b/keyboards/k34/readme.md
new file mode 100644
index 0000000000..8f17c7e5de
--- /dev/null
+++ b/keyboards/k34/readme.md
@@ -0,0 +1,25 @@
+# k34
+
+![k34](https://i.imgur.com/tarkFIph.jpeg)
+
+## Keyboard Info
+
+The K34 is a custom 34-key unibody keyboard.
+
+* Keyboard Maintainer: [wongjingping](https://github.com/wongjingping)
+All hardware supported can be found in the [k34 repository](https://github.com/wongjingping/k34)
+
+## Flashing Instructions
+
+To enter the bootloader, short the RST and GND pins, or press the key mapped to `RESET`.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make k34:default
+
+Flashing example for this keyboard:
+
+ make k34:default:flash
+
+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).
+