aboutsummaryrefslogtreecommitdiff
path: root/keyboards/magic_force/mf34/readme.md
diff options
context:
space:
mode:
authorNick Brassel <[email protected]>2023-11-28 16:39:48 +1100
committerNick Brassel <[email protected]>2023-11-28 16:40:47 +1100
commit0115951de12bd4c798a43a380651c34552552e85 (patch)
tree62999011ae782d93aa6dc9c889615db2a840cafc /keyboards/magic_force/mf34/readme.md
parent0379d1f59e58cefa18cdb72ba1b77507d1108ae6 (diff)
parent4d99e0a23cff02f4c6e55e093b5de08a9be0df7c (diff)
downloadqmk_firmware-0.23.0.tar.gz
qmk_firmware-0.23.0.zip
`develop` -> `master`, 2023q4 edition0.23.0
Diffstat (limited to 'keyboards/magic_force/mf34/readme.md')
-rw-r--r--keyboards/magic_force/mf34/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/magic_force/mf34/readme.md b/keyboards/magic_force/mf34/readme.md
new file mode 100644
index 0000000000..25a72d644f
--- /dev/null
+++ b/keyboards/magic_force/mf34/readme.md
@@ -0,0 +1,23 @@
+# MF-34
+
+A customizable 34 keyboard, support both HOTSWAP and SOLDER.
+
+* Keyboard Maintainer: [gezhaoyou](https://github.com/gezhaoyou)
+* Hardware Supported: [gezhaoyou](https://github.com/gezhaoyou)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make magic_force/mf34:default
+
+Flashing example for this keyboard:
+
+ make magic_force/mf34:default:flash
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Physical reset button**: Briefly press the button: [boot] first, then press button: [reset] on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
+
+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).