qmk_firmware/keyboards/mechmini/readme.md
TurboMech 6b584a23c0 Updated ACR60, Mechmini, ALU84 readme information and config.h descripters (#2231)
* Updated ACR60, Mechmini, ALU84 readme information and config.h descripters

Update MECHKEYS keyboards to be uniform in readmes and config.h's PID, MANUFACTORER, and DESCRIPTIONS.   This allows the keyboards to be more uniform amongst the different types.

* Rename keyboards/alu84/keymaps/TurboMech/config.h to keyboards/alu84/keymaps/turbomech

* Rename keyboards/alu84/keymaps/turbomech to keyboards/alu84/keymaps/TurboMech/config.h

* Fixed folder naming for alu84/keymaps/turbomech

* fixed error from compile

removed double `return MACRO_NONE;` and `switch (id) {`
2018-01-05 11:37:22 -05:00

29 lines
1.2 KiB
Markdown

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 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.