From 9cb1d36974b7ea4c380c0b7818812f6f5aae56c1 Mon Sep 17 00:00:00 2001
From: TurboMech <sarmstrong240@gmail.com>
Date: Wed, 3 Jan 2018 05:48:09 -0500
Subject: 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.
---
 keyboards/mechmini/v1/README.md | 83 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 keyboards/mechmini/v1/README.md

(limited to 'keyboards/mechmini/v1/README.md')

diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md
new file mode 100644
index 0000000000..9f44a9c2cd
--- /dev/null
+++ b/keyboards/mechmini/v1/README.md
@@ -0,0 +1,83 @@
+Mechmini V1
+===========
+
+A 40% ortholinear/staggered keyboard, that was originally bootmapper and can be ported to QMK following this readme.  This version is no longer in production [More info on MECHKEYS](https://mechkeys.ca).
+
+Keyboard Maintainer: QMK Community 
+Hardware Supported: Mechmini 1 PCB  
+Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make mechmini/v1: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.
+
+## 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
+
+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.
+3. If errors happen with 
+`./tmk_core/common/avr/suspend.c` it is likely you implemented a RGB underglow sleep setting previously.  Simply comment out the following code found under `void suspend_wakeup_init(void)`:
+```
+ifdef RGBLIGHT_ANIMATIONS
+    rgblight_timer_enable();
+    _delay_ms(50);
+    rgblight_set();
+#endif
+```
+So that the resulting code should know reflect:
+```
+/*#ifdef RGBLIGHT_ANIMATIONS
+    rgblight_timer_enable();
+    _delay_ms(50);
+    rgblight_set();
+#endif*/
+```
+
+
-- 
cgit v1.2.1