[Keyboard] Snagpad Configurator bugfix and readme refactor (#6381)

[qmk_firmware.git] / keyboards / mechmini / readme.md

diff --git a/keyboards/mechmini/readme.md b/keyboards/mechmini/readme.md
index b95153051c975d13777ec01c7d8b59ccaddaa2aa..fc43eb124845fefcfebbffa2f127082ecac22ca1 100644 (file)
--- a/keyboards/mechmini/readme.md
+++ b/keyboards/mechmini/readme.md
@@ -1,64 +1,28 @@
-mechmini
+Mechmini
 ========
 
-A compact ortholinear/staggered keyboard.
+![mechmini](https://cdn.shopify.com/s/files/1/1697/5323/products/20495451_468333093530388_1648547540_o_grande.jpg?v=1510792821)
 
-Keyboard Maintainer: QMK Community
-Hardware Supported: mechmini PCB
-Hardware Availability: https://mechkeys.ca/collections/keyboards/products/mechmini-2-0-pcb
+A 40% compact ortholinear/staggered keyboard. 
 
-Make example for this keyboard (after setting up your build environment):
+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 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
-
-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.
+Version 2 (Mechmini 2.0) was shipped powered by QMK [More info on MECHKEYS](https://mechkeys.ca).
 
-## Installing
+Keyboard Maintainer: QMK Community (version 1) & [TurboMech](https://github.com/TurboMech) (version 2 - aka Mechmini 2.0)
 
-First, install the requirements. These commands are for OSX, but all you
-need is the AVR toolchain and `bootloadHID` for flashing:
+Hardware Supported: Mechmini keyboard
 
-```
-$ brew cask install crosspack-avr
-$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-```
+Hardware Availability: [MECHKEYS](https://mechkeys.ca/collections/keyboards/products/mechmini-2-0)
 
-In order to use the `./program` script, which can reboot the board into
-the bootloader, you'll need Python 2 with PyUSB installed:
+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:
 
-```
-$ pip install pyusb
-```
-
-Then, with the keyboard plugged in, simply run this command from the
-`qmk_firmware` directory:
-
-```
-$ make mechmini:program
-```
+    make mechmini:default
 
-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:
+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.
 
-```
-$ make mechmini
-$ bootloadHID -r mechmini_default.hex
-```
+## Mechmini Notes
 
-## 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.