summaryrefslogtreecommitdiff
path: root/keyboards/monsgeek/m1/readme.md
diff options
context:
space:
mode:
authorjonylee@hfd <108282809+jonylee1986@users.noreply.github.com>2023-07-27 10:04:41 +0800
committerGitHub <noreply@github.com>2023-07-26 19:04:41 -0700
commitc890766a45d5092853e3b7c9b057cb23a039fe73 (patch)
tree1edd27ff8aaae6663cf1804ef3730001e297b847 /keyboards/monsgeek/m1/readme.md
parenteb188bd4eefc61f49540cbdd389673de63b2b185 (diff)
[Keyboard] Add m1 keyboard (#19799)
Co-authored-by: adophoxia <100170946+adophoxia@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: wb-joy <chang.li@westberrytech.com> Co-authored-by: Joy Lee <joylee.lc@foxmail.com>
Diffstat (limited to 'keyboards/monsgeek/m1/readme.md')
-rw-r--r--keyboards/monsgeek/m1/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/monsgeek/m1/readme.md b/keyboards/monsgeek/m1/readme.md
new file mode 100644
index 0000000000..72af4c4382
--- /dev/null
+++ b/keyboards/monsgeek/m1/readme.md
@@ -0,0 +1,19 @@
+# monsgeek m1 keyboard
+
+A customizable 75% encoder keyboard.
+
+* Keyboard Maintainer: [jonylee@hfd](https://github.com/jonylee1986)
+* Hardware Supported: m1
+* Hardware Availability: [monsgeek](https://www.monsgeek.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make monsgeek/m1:default
+
+Flashing example for this keyboard:
+
+ make monsgeek/m1:default:flash
+
+**Reset Key**: Hold down the key located at *K00*, 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).