1 files changed, 8 insertions, 72 deletions
diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md
index 315349803..902948c24 100644
--- a/keyboards/mechmini/v1/README.md
+++ b/keyboards/mechmini/v1/README.md
@@ -1,83 +1,19 @@
-Mechmini V1
+# 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 
+* Keyboard Maintainer: QMK Community
-Hardware Supported: Mechmini 1 PCB  
+* Hardware Supported: Mechmini 1 PCB
-Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
+* 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/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
-## Mechmini Notes
+    make mechmini/v1:default:flash
-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 `./util/atmega32a_program.py` 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*/
-```
+**Reset Key**: Hold down the key commonly programmed as *L_Ctrl* while plugging in the keyboard.
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

diff --git a/keyboards/mechmini/v1/README.md b/keyboards/mechmini/v1/README.md index 315349803..902948c24 100644 --- a/keyboards/mechmini/v1/README.md +++ b/keyboards/mechmini/v1/README.md
@@ -1,83 +1,19 @@
1	Mechmini V1	1	# Mechmini V1
2	===========
3		2
4	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).	3	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).
5		4
6	Keyboard Maintainer: QMK Community	5	* Keyboard Maintainer: QMK Community
7	Hardware Supported: Mechmini 1 PCB	6	* Hardware Supported: Mechmini 1 PCB
8	Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)	7	* Hardware Availability: Version 1 (Bootmapper) no longer in production [MECHKEYS](https://mechkeys.ca)
9		8
10	Make example for this keyboard (after setting up your build environment):	9	Make example for this keyboard (after setting up your build environment):
11		10
12	make mechmini/v1:default	11	make mechmini/v1:default
13		12
14	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.	13	Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
15		14
16	## Mechmini Notes	15	make mechmini/v1:default:flash
17
18	Note that this is a complete replacement for the firmware, so you won't be
19	using Bootmapper Client to change any keyboard settings, since not all the
20	USB report options are supported.
21
22	## Installing
23
24	First, install the requirements. These commands are for OSX, but all you
25	need is the AVR toolchain and `bootloadHID` for flashing:
26
27	```
28	$ brew cask install crosspack-avr
29	$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
30	```
31
32	In order to use the `./util/atmega32a_program.py` script, which can reboot the board into
33	the bootloader, you'll need Python 2 with PyUSB installed:
34
35	```
36	$ pip install pyusb
37	```
38
39	Then, with the keyboard plugged in, simply run this command from the
40	`qmk_firmware` directory:
41
42	```
43	$ make mechmini:program
44	```
45
46	If you prefer, you can just build it and flash the firmware directly with
47	`bootloadHID` if you boot the board while holding down `L_Ctrl` to keep it
48	in the bootloader:
49
50	```
51	$ make mechmini
52	$ bootloadHID -r mechmini_default.hex
53	```
54
55	## Troubleshooting
56
57	From my experience, it's really hard to brick these boards. But these
58	tricks have been useful when it got stuck in a weird scenario.
59
60	1. Try plugging the board in while pressing `L_Ctrl`. This will force it
61	to boot only the bootloader without loading the firmware. Once this is
62	done, just reflash the board with the original firmware.
63	2. Sometimes USB hubs can act weird, so try connecting the board directly
64	to your computer or plugging/unplugging the USB hub.
65	3. If errors happen with
66	`./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)`:
67	```
68	ifdef RGBLIGHT_ANIMATIONS
69	rgblight_timer_enable();
70	_delay_ms(50);
71	rgblight_set();
72	#endif
73	```
74	So that the resulting code should know reflect:
75	```
76	/*#ifdef RGBLIGHT_ANIMATIONS
77	rgblight_timer_enable();
78	_delay_ms(50);
79	rgblight_set();
80	#endif*/
81	```
82		16
		17	Reset Key: Hold down the key commonly programmed as L_Ctrl while plugging in the keyboard.
83		18
		19	See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).