qmk-firmware/keyboards/mechmini/readme.md
TurboMech 9cb1d36974 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.
2018-01-03 10:32:53 -05:00

25 lines
1.1 KiB
Markdown

Mechmini
========
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: 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 mechmini: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.