summaryrefslogtreecommitdiffstats
path: root/keyboards/mechkeys/mechmini/v1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechkeys/mechmini/v1/readme.md')
-rw-r--r--keyboards/mechkeys/mechmini/v1/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/mechkeys/mechmini/v1/readme.md b/keyboards/mechkeys/mechmini/v1/readme.md
new file mode 100644
index 0000000000..d6b88d9c04
--- /dev/null
+++ b/keyboards/mechkeys/mechmini/v1/readme.md
@@ -0,0 +1,19 @@
+# Mechmini V1
+
+A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme. This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca).
+
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: Mechmini 1 PCB
+* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make mechkeys/mechmini/v1:default
+
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+ make mechkeys/mechmini/v1:default:flash
+
+**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* 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).