summaryrefslogtreecommitdiff
path: root/keyboards/mothwing/readme.md
diff options
context:
space:
mode:
authortan-t <22813443+tan-t@users.noreply.github.com>2023-07-14 16:22:38 +0900
committerGitHub <noreply@github.com>2023-07-14 00:22:38 -0700
commitfa0b4511dddffa56812a86ab93f90d5221f43585 (patch)
tree528002d78d9e524c8ae5eed506af9442de5e0b72 /keyboards/mothwing/readme.md
parent28d5cd169670a22f6b451d8c93c1956f6f58e28e (diff)
[Keyboard] add mothwing (#19342)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/mothwing/readme.md')
-rw-r--r--keyboards/mothwing/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/mothwing/readme.md b/keyboards/mothwing/readme.md
new file mode 100644
index 0000000000..184f608c5d
--- /dev/null
+++ b/keyboards/mothwing/readme.md
@@ -0,0 +1,23 @@
+# MOTHWING
+
+A split keyboard with 3x6 vertically staggered keys and 4 thumb keys.
+
+* Keyboard Maintainer: [tan-t](https://github.com/tan-t)
+* Hardware Supported: MOTHWING PCB
+* Hardware Availability: currently unavailable. merch will be open around August 2023.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mothwing:default
+
+Flashing example for this keyboard:
+
+ make mothwing: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
+
+Enter the bootloader by:
+
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available