summaryrefslogtreecommitdiff
path: root/keyboards/mechmini/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechmini/readme.md')
-rw-r--r--keyboards/mechmini/readme.md62
1 files changed, 11 insertions, 51 deletions
diff --git a/keyboards/mechmini/readme.md b/keyboards/mechmini/readme.md
index ef0602297c..56dd81a244 100644
--- a/keyboards/mechmini/readme.md
+++ b/keyboards/mechmini/readme.md
@@ -1,13 +1,17 @@
-mechmini
+Mechmini
========
-A compact ortholinear/staggered keyboard.
+A 40% compact ortholinear/staggered keyboard.
-Keyboard Maintainer: QMK Community
-Hardware Supported: mechmini PCB
-Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0-pcb
+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.
-Make example for this keyboard (after setting up your build environment):
+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
@@ -15,50 +19,6 @@ See [build environment setup](https://docs.qmk.fm/build_environment_setup.html)
## Mechmini Notes
-Note that this is a complete replacement for the firmware, so you won't be
-using Bootmapper Client to change any keyboard settings, since not all the
-USB report options are supported.
-
-## Installing
-
-First, install the requirements. These commands are for OSX, but all you
-need is the AVR toolchain and `bootloadHID` for flashing:
-
-```
-$ brew cask install crosspack-avr
-$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-```
-
-In order to use the `./program` script, which can reboot the board into
-the bootloader, you'll need Python 2 with PyUSB installed:
-
-```
-$ pip install pyusb
-```
-
-Then, with the keyboard plugged in, simply run this command from the
-`qmk_firmware` directory:
-
-```
-$ make mechmini:program
-```
-
-If you prefer, you can just build it and flash the firmware directly with
-`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
-in the bootloader:
-
-```
-$ make mechmini
-$ bootloadHID -r mechmini_default.hex
-```
-
-## Troubleshooting
+There are 2 versions of the Mechmini keyboard. Please read the readme for the version you have for make instructions.
-From my experience, it's really hard to brick these boards. But these
-tricks have been useful when it got stuck in a weird scenario.
-1. Try plugging the board in while pressing `L_Ctrl`. This will force it
- to boot only the bootloader without loading the firmware. Once this is
- done, just reflash the board with the original firmware.
-2. Sometimes USB hubs can act weird, so try connecting the board directly
- to your computer or plugging/unplugging the USB hub.