summaryrefslogtreecommitdiff
path: root/keyboards/ymdk/ym68/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ymdk/ym68/readme.md')
-rw-r--r--keyboards/ymdk/ym68/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/ymdk/ym68/readme.md b/keyboards/ymdk/ym68/readme.md
new file mode 100644
index 0000000000..5437375dfd
--- /dev/null
+++ b/keyboards/ymdk/ym68/readme.md
@@ -0,0 +1,24 @@
+# YM68
+
+![YM68](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/ymdk/ym68/HTB17n9gQMHqK1RjSZFEq6AGMXXaq_640.jpg)
+
+A 65% keyboard kit with support for in-switch LEDs and RGB Underglow.
+
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: YMDK YM68 PCB (ATmega32U4)
+* Hardware Availability: [AliExpress](https://www.aliexpress.com/i/32999629504.html), [ymdkey.com](https://ymdkey.com/collections/68-71-keyboard-diy/products/ymdk-fully-programmable-68-cnc-aluminum-case-plate-pcb-stabilizers-mechanical-keyboard-diy-kit?variant=30994625232957)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ymdk/ym68:default
+
+Flashing example for this keyboard:
+
+ make ymdk/ym68:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Tap the Reset switch mounted on the bottom side of the PCB
+* Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings)
+
+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).