summaryrefslogtreecommitdiff
path: root/keyboards/ymdk/yd60mq/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ymdk/yd60mq/readme.md')
-rw-r--r--keyboards/ymdk/yd60mq/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/ymdk/yd60mq/readme.md b/keyboards/ymdk/yd60mq/readme.md
new file mode 100644
index 0000000000..9a8dece4da
--- /dev/null
+++ b/keyboards/ymdk/yd60mq/readme.md
@@ -0,0 +1,29 @@
+# YD60MQ
+
+![YD60MQ PCB](https://ae01.alicdn.com/kf/HTB1PVQ2X_HuK1RkSndVq6xVwpXaO.jpg)
+
+Customizable 60% PCB by [YMDK](https://ymdk.aliexpress.com/store/429151?spm=2114.10010108.0.0.3ab23641lIkgzm).
+
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: YD60MQ PCB
+ * 12led (unknown revision number, has 12 RGB LEDs on the back) – _default variant_
+ * 16led (unknown revision number, has 16 RGB LEDs on the back)
+* Hardware Availability: [YMDK on AliExpress](https://www.aliexpress.com/i/32869207240.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+```sh
+make ymdk/yd60mq:default # builds the 12 LED variant
+make ymdk/yd60mq/12led:default # also builds the 12 LED variant
+make ymdk/yd60mq/16led:default # builds the 16 LED variant
+```
+
+The keyboard uses a DFU bootloader. To make a keymap and use dfu to flash it:
+
+```sh
+make ymdk/yd60mq:default:flash # builds and flashes the 12 LED variant
+make ymdk/yd60mq/12led:default:flash # also builds and flashes the 12 LED variant
+make ymdk/yd60mq/16led:default:flash # builds and flashes the 16 LED variant
+```
+
+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).