summaryrefslogtreecommitdiff
path: root/keyboards/jukaie/jk01/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/jukaie/jk01/readme.md')
-rw-r--r--keyboards/jukaie/jk01/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/jukaie/jk01/readme.md b/keyboards/jukaie/jk01/readme.md
new file mode 100644
index 0000000000..a9dbac18ac
--- /dev/null
+++ b/keyboards/jukaie/jk01/readme.md
@@ -0,0 +1,23 @@
+# jk01
+
+An 83 keys keyboard, Equipped with the WestBerry Q95 microcontroller.
+
+* Keyboard Maintainer: [JUKAIE](https://github.com/jukaie)
+* Hardware Supported: JK01
+* Hardware Availability: [JUKAIE](https://github.com/jukaie/keyboard1)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jukaie/jk01:default
+
+Flashing example for this keyboard:
+
+ make jukaie/jk01:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Hold the Reset switch mounted on the surface of the PCB back side after the USB cable is connected
+* Hold the Escape key while connecting the USB cable (also erases persistent settings)
+* Fn+ESC will reset the board to 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).