summaryrefslogtreecommitdiff
path: root/keyboards/monsgeek/m3/readme.md
diff options
context:
space:
mode:
authorjonylee@hfd <108282809+jonylee1986@users.noreply.github.com>2023-10-11 05:07:59 +0800
committerGitHub <noreply@github.com>2023-10-10 14:07:59 -0700
commit0650f783b55c90d3c5f994857daf0092495e4231 (patch)
tree54342af8bf65bbee8dc42562669e8b35ac7dc402 /keyboards/monsgeek/m3/readme.md
parent6dafcac71399d1d4a4af1b6bfb36d73c6c9155ce (diff)
[Keyboard] MonsGeek M3 (#20542)
* Add keybord monsgeek m3. * Add keybord monsgeek m3. * Add keybord monsgeek m3. * updata rules.mk * add readme.md * delete monsgeek\m3\rgb_matrix_kb.inc * add DISABLE_M3_KEYCODES * user_config --> kb_config * Move code to info.json,and removed redundant features * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/info.json * Update readme.md * Update keyboards/monsgeek/m3/config.h * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/keymaps/default/keymap.c * Update keyboards/monsgeek/m3/keymaps/via/keymap.c * Update keyboards/monsgeek/m3/readme.md * Update m3.c * Update m3.c * Update info.json * Update keymap.c * Update keymap.c * Update config.h * Update keyboards/monsgeek/m3/readme.md * Update keyboards/monsgeek/m3/rules.mk * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/keymaps/default/keymap.c * Update keyboards/monsgeek/m3/keymaps/via/keymap.c * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/info.json * Update m3.c * Update keyboards/monsgeek/m3/info.json * Update keyboards/monsgeek/m3/m3.c * Update keymap.c replace the tabs with spaces * Update keymap.c replace the tabs with spaces
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