summaryrefslogtreecommitdiff
path: root/keyboards/mntre/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mntre/readme.md')
-rw-r--r--keyboards/mntre/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/mntre/readme.md b/keyboards/mntre/readme.md
new file mode 100644
index 0000000000..4c827aeb25
--- /dev/null
+++ b/keyboards/mntre/readme.md
@@ -0,0 +1,27 @@
+# MNT Reform USB Keyboard (Standalone)
+
+![MNT Reform USB Keyboard (Standalone)](https://shop.mntmn.com/spree/products/117/large/reform-standalone-black-full.jpg)
+
+A compact and slim mechanical keyboard designed for comfort and portability.
+
+* Keyboard QMK port Maintainer: [cdc-mkb](https://github.com/cdc-mkb)
+* Hardware Supported: MNT Reform USB Keyboard (Standalone)
+* Hardware Availability: https://shop.mntmn.com/products/mnt-reform-usb-keyboard-standalone
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mntre:default
+
+Flashing example for this keyboard:
+
+ make mntre: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 3 ways:
+
+* **Bootmagic reset**: Hold down the "Esc" key and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available (default: "Circle" + "R")
+* **Physical reset button**: Remove the keyboard’s frame and toggle the programming DIP switch SW84 on the keyboard to “ON”. Then press the reset button SW83.