summaryrefslogtreecommitdiffstats
path: root/keyboards/yd68/readme.md
diff options
context:
space:
mode:
authorizzy84075 <izzy84075@gmail.com>2018-09-29 21:44:54 +0200
committerDrashna Jaelre <drashna@live.com>2018-09-29 21:44:54 +0200
commit92d95ba1e1223538f8c16fe2d17a23fa0dd67725 (patch)
tree2a02d935efc4bd2355e04ce25a7bfc68b32e6add /keyboards/yd68/readme.md
parent68854f0735ecfa69e383c1f7c93211a6ad89e13b (diff)
downloadqmk_firmware-92d95ba1e1223538f8c16fe2d17a23fa0dd67725.tar.gz
qmk_firmware-92d95ba1e1223538f8c16fe2d17a23fa0dd67725.tar.xz
Keyboard: Add basic support for the YD68 / YD68v2 PCBs. (#4020)
* Add basic support for the YD68 / YD68v2. Keymap and WS2812 underlighting work. Capslock LED should work, though I don't have one populated to test. Backlight LEDs are not set up, as they're not on a hardware PWM pin, could be set up as software. * Fix Imgur link * Fix default keymap to match the stock firmware * Fix the Hardware Supported line and add a short description
Diffstat (limited to 'keyboards/yd68/readme.md')
-rw-r--r--keyboards/yd68/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/yd68/readme.md b/keyboards/yd68/readme.md
new file mode 100644
index 000000000..7e5e83bcc
--- /dev/null
+++ b/keyboards/yd68/readme.md
@@ -0,0 +1,15 @@
+# yd68
+
+[yd68](https://imgur.com/gallery/Ygo668L)
+
+A 68-key board with RGB underlighting and bluetooth.
+
+Keyboard Maintainer: [Izzy84075](https://github.com/izzy84075)
+Hardware Supported: YD68/YD68v2
+Hardware Availability: [KBDFans](https://kbdfans.cn/collections/diy-kit/products/yd68-65-bluetooth-custom-keyboard-pcb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make yd68:default
+
+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).