aboutsummaryrefslogtreecommitdiff
path: root/keyboards/monsgeek/m5/readme.md
diff options
context:
space:
mode:
authorjonylee@hfd <[email protected]>2023-06-21 11:01:43 +0800
committerGitHub <[email protected]>2023-06-20 21:01:43 -0600
commit595d393fd82d7cde0216667e64809c1923cb337c (patch)
tree833395a2fdaf2dc1b4024fb1a338cc207eeb8206 /keyboards/monsgeek/m5/readme.md
parent2f1cac6e9febd6209ff9a012b7fcd03af4f9cb82 (diff)
downloadqmk_firmware-595d393fd82d7cde0216667e64809c1923cb337c.tar.gz
qmk_firmware-595d393fd82d7cde0216667e64809c1923cb337c.zip
[Keyboard] Add Monsgeek M5 (#21182)
Co-authored-by: adophoxia <[email protected]> Co-authored-by: jack <[email protected]>
Diffstat (limited to 'keyboards/monsgeek/m5/readme.md')
-rw-r--r--keyboards/monsgeek/m5/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/monsgeek/m5/readme.md b/keyboards/monsgeek/m5/readme.md
new file mode 100644
index 0000000000..6574b3d663
--- /dev/null
+++ b/keyboards/monsgeek/m5/readme.md
@@ -0,0 +1,20 @@
+# m5
+
+A customizable 100% keyboard.
+
+* Keyboard Maintainer: [jonylee@hfd](https://github.com/jonylee1986)
+* Hardware Supported: m5
+* Hardware Availability: [monsgeek](https://www.monsgeek.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make monsgeek/m5:default
+
+Flashing example for this keyboard:
+
+ make monsgeek/m5:default:flash
+
+## Bootloader
+**Reset Key**: Hold down the key located at *K000*, which programmed as *Esc* while plugging in the keyboard.
+
+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).