summaryrefslogtreecommitdiff
path: root/keyboards/ydkb/ydpm40/readme.md
diff options
context:
space:
mode:
authorxofyarg <xofyarg@users.noreply.github.com>2022-12-12 13:16:26 -0800
committerGitHub <noreply@github.com>2022-12-12 13:16:26 -0800
commit25790fc886a189f5f200a1ac6f93d088c417249a (patch)
treebe4f040b82a2a1bb72af9c7964d69431533f9446 /keyboards/ydkb/ydpm40/readme.md
parentb8532d100dbd63f48f65e8c1d8f57b083e9107cd (diff)
[Keyboard] add ydpm40 keyboard (#19294)
Diffstat (limited to 'keyboards/ydkb/ydpm40/readme.md')
-rw-r--r--keyboards/ydkb/ydpm40/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/ydkb/ydpm40/readme.md b/keyboards/ydkb/ydpm40/readme.md
new file mode 100644
index 0000000000..6a7bbe86e5
--- /dev/null
+++ b/keyboards/ydkb/ydpm40/readme.md
@@ -0,0 +1,22 @@
+# ydkb/ydpm40
+
+A pair of 40% keyboards, that share the same PCB, designed by yang. Among the two, ydp40 has a Planck-like layout, while ydm40 is more traditional.
+
+* Keyboard Maintainer: [xofyarg](https://github.com/xofyarg)
+* Hardware Supported: https://github.com/yangdigi/YDPM40-Keyboard-PCB
+* Hardware Availability: https://ydkb.world.taobao.com/
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ydkb/ydpm40:default
+
+Flashing example for this keyboard:
+
+ make ydkb/ydpm40: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).
+
+## Bootloader
+
+The ATmega328P MCU comes with BootloadHID. To enter it, hold down the
+top left key and plug in the keyboard.