summaryrefslogtreecommitdiff
path: root/keyboards/ymdk/ymd21/v2/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2022-02-26 17:36:30 -0800
committerGitHub <noreply@github.com>2022-02-26 17:36:30 -0800
commitc1e008b0520a983226622af21e82d7ebe24b83f3 (patch)
tree6bb8e890810dda48e268282f24808d8ff2dd2bf9 /keyboards/ymdk/ymd21/v2/readme.md
parent97d0e7cb2d1b4e3db16aa68a3d87437ffd472ffe (diff)
[Keyboard] add YMDK YMD21 v2 (#16442)
* [Keyboard] add YMDK YMD21 v2 * remove trailing whitespace from default keymap
Diffstat (limited to 'keyboards/ymdk/ymd21/v2/readme.md')
-rw-r--r--keyboards/ymdk/ymd21/v2/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/ymdk/ymd21/v2/readme.md b/keyboards/ymdk/ymd21/v2/readme.md
new file mode 100644
index 0000000000..8a7968e346
--- /dev/null
+++ b/keyboards/ymdk/ymd21/v2/readme.md
@@ -0,0 +1,27 @@
+# YMDK YMD21 v2
+
+![YMDK YMD21 v2](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/ymdk/ymd21/v2/New-YMD21-V2-QMK-VIA-21-23-24-Key-RGB-Programmable-Marco-Function-MX-Cherry-Gateron.jpg_Q90.jpg_1_640.jpg)
+
+A 21-to-24-key numpad with RGB Underglow, USB-C, and support for in-switch LEDs.
+
+* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
+* Hardware Supported: YMDK YMD21 v2 (ATmega32U4)
+* Hardware Availability: [YMDKey.com](https://ymdkey.com/collections/num-pad-diy/products/new-ymd21-v2-qmk-via-21-23-24-key-rgb-programmable-marco-function-mx-cherry-gateron-switches-numpad-for-lol-battlegrounds), [AliExpress](https://www.aliexpress.com/item/32916152785.html)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ymdk/ymd21/v2:default
+
+Flashing example for this keyboard:
+
+ make ymdk/ymd21/v2:default:flash
+
+## Bootloader
+
+Enter the bootloader using one of the following methods:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+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).