summaryrefslogtreecommitdiffstats
path: root/keyboards/ymdk/wingshs/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ymdk/wingshs/readme.md')
-rw-r--r--keyboards/ymdk/wingshs/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/ymdk/wingshs/readme.md b/keyboards/ymdk/wingshs/readme.md
new file mode 100644
index 0000000000..811fd0e6da
--- /dev/null
+++ b/keyboards/ymdk/wingshs/readme.md
@@ -0,0 +1,21 @@
+# YMDK Wings Hotswap
+
+![Wings Hotswap](https://cdn.shopify.com/s/files/1/0006/5227/9869/products/IMG_0172_2048x2048.jpg?v=1624963313)
+
+A keyboard inspired by the Arisu, which is inspired by Lyn's EM7 and TGR Alice. This has a different LED and matrix configuration from the non-hotswap YMDK Wings.
+
+* Keyboard Maintainer: [alittlepeace](https://github.com/alittlepeace)
+* Hardware Supported: YMDK Wings Hotswap
+* Hardware Availability: [YMDK](https://ymdkey.com/products/gbymdk-wings-aluminum-cnc-top-bottom-qmk-rgb-hotswap-v1-pcb-diy-kit)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ymdk/wingshs:default
+
+Flashing example for this keyboard:
+
+ make ymdk/wingshs:default:flash
+
+To reset the board into bootloader mode, 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).