summaryrefslogtreecommitdiffstats
path: root/keyboards/monsgeek/m3/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/monsgeek/m3/readme.md')
-rw-r--r--keyboards/monsgeek/m3/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/monsgeek/m3/readme.md b/keyboards/monsgeek/m3/readme.md
new file mode 100644
index 0000000000..32e9112276
--- /dev/null
+++ b/keyboards/monsgeek/m3/readme.md
@@ -0,0 +1,24 @@
+# MonsGeek M3
+
+A customizable 80% keyboard.
+
+* Keyboard Maintainer: [jonylee@hfd](https://github.com/jonylee1986)
+* Hardware Supported: MonsGeek M3 PCB
+* Hardware Availability: [monsgeek](https://www.monsgeek.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make monsgeek/m3:default
+
+Flashing example for this keyboard:
+
+ make monsgeek/m3: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 in 2 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available