summaryrefslogtreecommitdiffstats
path: root/keyboards/mechmini/v2/README.md
diff options
context:
space:
mode:
authorTurboMech <sarmstrong240@gmail.com>2018-01-03 11:48:09 +0100
committerJack Humbert <jack.humb@gmail.com>2018-01-03 16:32:53 +0100
commit9cb1d36974b7ea4c380c0b7818812f6f5aae56c1 (patch)
tree161b1b36ac787aed9f7c7959dd756315c435dcbc /keyboards/mechmini/v2/README.md
parent0a5d302622b440183fbb42593fd07c4da11abba3 (diff)
downloadqmk_firmware-9cb1d36974b7ea4c380c0b7818812f6f5aae56c1.tar.gz
qmk_firmware-9cb1d36974b7ea4c380c0b7818812f6f5aae56c1.tar.xz
Added Mechmini 2.0 to Mechmini keyboard folder
This creates a v1 and v2 subproject. V1 retains all the same implementations of the bootmapper-ported Mechmnini 1 including #2196. V2 adds the Mechmini 2.0 kayboard support (I know it took me way to long to get it a pull request in). All readme's updated to reflect compiling the two seperate keyboards. Simply either `make mechmini/v1:default` or `make mechmini/v2:defualt`. Utilizing the rules.mk using `make mechmini:default` will automatically create the Mechmini 2 default keymap as this is the current version and has a much wider user base.
Diffstat (limited to 'keyboards/mechmini/v2/README.md')
-rw-r--r--keyboards/mechmini/v2/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/mechmini/v2/README.md b/keyboards/mechmini/v2/README.md
new file mode 100644
index 000000000..e1efc9904
--- /dev/null
+++ b/keyboards/mechmini/v2/README.md
@@ -0,0 +1,20 @@
+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: 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 mechmini/v2:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) 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.