summaryrefslogtreecommitdiff
path: root/keyboards/mechkeys/mechmini/v2/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechkeys/mechmini/v2/readme.md')
-rw-r--r--keyboards/mechkeys/mechmini/v2/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/mechkeys/mechmini/v2/readme.md b/keyboards/mechkeys/mechmini/v2/readme.md
new file mode 100644
index 0000000000..8724f16a0f
--- /dev/null
+++ b/keyboards/mechkeys/mechmini/v2/readme.md
@@ -0,0 +1,22 @@
+Mechmini 2.0
+============
+
+A 40% compact ortholinear/staggered keyboard.
+
+Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca).
+
+Keyboard Maintainer: [TurboMech](https://github.com/TurboMech)
+
+Hardware Supported: Mechmini 2.0 keyboard
+
+Hardware Availability: [MECHKEYS Mechmini 2.0](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):
+
+ make mechkeys/mechmini/v2: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.