aboutsummaryrefslogtreecommitdiff
path: root/keyboards/mwstudio/mmk_3/readme.md
diff options
context:
space:
mode:
authorTW59420 <[email protected]>2023-12-12 11:21:09 +0800
committerGitHub <[email protected]>2023-12-11 19:21:09 -0800
commitc4a2bea0e6aac51b8c0806f31614383e267eb1d7 (patch)
tree48144d24de5d532472e4d3b2d9d34d044a9f8708 /keyboards/mwstudio/mmk_3/readme.md
parentae6f6c3365452bfa27b451b9ca981d6a4c93c1c2 (diff)
downloadqmk_firmware-c4a2bea0e6aac51b8c0806f31614383e267eb1d7.tar.gz
qmk_firmware-c4a2bea0e6aac51b8c0806f31614383e267eb1d7.zip
[Keyboard] add mmk_3 (#22569)
Co-authored-by: jack <[email protected]> Co-authored-by: Ryan <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Joel Challis <[email protected]>
Diffstat (limited to 'keyboards/mwstudio/mmk_3/readme.md')
-rw-r--r--keyboards/mwstudio/mmk_3/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/mwstudio/mmk_3/readme.md b/keyboards/mwstudio/mmk_3/readme.md
new file mode 100644
index 0000000000..997dbc382a
--- /dev/null
+++ b/keyboards/mwstudio/mmk_3/readme.md
@@ -0,0 +1,22 @@
+# 3Key
+
+![3Key](https://i.imgur.com/WuwlVknh.jpeg)
+
+Support APM32F103C8T6 keyboard.
+
+* Keyboard Maintainer: [TW59420](https://github.com/TW59420)
+* Hardware Supported: APM32F103C8T6
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mwstudio/mmk_3:default
+
+Flashing example for this keyboard:
+
+ make mwstudio/mmk_3: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
+* **Physical reset button**: Short press the button on the back of the PCB to enter the Bootloader and flash the firmware
+* **Keycode in layout**: Press the key mapped to RESET if it is available