summaryrefslogtreecommitdiff
path: root/keyboards/mechkeys/mechmini/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechkeys/mechmini/readme.md')
-rw-r--r--keyboards/mechkeys/mechmini/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/mechkeys/mechmini/readme.md b/keyboards/mechkeys/mechmini/readme.md
new file mode 100644
index 0000000000..f9c0264273
--- /dev/null
+++ b/keyboards/mechkeys/mechmini/readme.md
@@ -0,0 +1,28 @@
+Mechmini
+========
+
+![mechmini](https://cdn.shopify.com/s/files/1/1697/5323/products/20495451_468333093530388_1648547540_o_grande.jpg?v=1510792821)
+
+A 40% compact ortholinear/staggered keyboard.
+
+Version 1 was originally bootmapper (ps2avrGB) and can be ported to QMK following the v1 readme (../mechmini/v1/readme.md). This version is no longer in production.
+
+Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca).
+
+Keyboard Maintainer: QMK Community (version 1) & [TurboMech](https://github.com/TurboMech) (version 2 - aka Mechmini 2.0)
+
+Hardware Supported: Mechmini keyboard
+
+Hardware Availability: [MECHKEYS](https://mechkeys.ca/collections/keyboards/products/mechmini-2-0)
+
+Make example for this keyboard (after setting up your build environment), this will make the Mechmini 2.0 default keymap (split space) - please see v1 readme for v1 make instructions:
+
+ make mechkeys/mechmini:default
+
+See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+
+## Mechmini Notes
+
+There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions.
+
+