[Keyboard] Update ATmega32A readme files to match template (#7462)

* Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review
author: Joel Challis <git@zvecr.com> 2019-11-24 04:42:20 +0000
committer: James Young <18669334+noroadsleft@users.noreply.github.com> 2019-11-23 20:42:20 -0800
commit: 6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch)
tree: 4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/exclusive/e6v2
parent: d14573620d3e964730af960aab3c05a5d061796f (diff)
download: qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz
qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.zip
2 files changed, 16 insertions, 66 deletions
diff --git a/keyboards/exclusive/e6v2/le_bmc/readme.md b/keyboards/exclusive/e6v2/le_bmc/readme.md
index 4dc8e6ef5..561560a3e 100644
--- a/keyboards/exclusive/e6v2/le_bmc/readme.md
+++ b/keyboards/exclusive/e6v2/le_bmc/readme.md
@@ -2,43 +2,18 @@
 These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1. 
-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
-Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller  
+* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
-Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)  
+* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
 Make example for this keyboard (after setting up your build environment):
    make exclusive/e6v2/le_bmc:default
-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make exclusive/e6v2/le_bmc:default:flash
-**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-    ```
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
 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/exclusive/e6v2/oe_bmc/readme.md b/keyboards/exclusive/e6v2/oe_bmc/readme.md
index a386abf6c..cd6da0ff0 100644
--- a/keyboards/exclusive/e6v2/oe_bmc/readme.md
+++ b/keyboards/exclusive/e6v2/oe_bmc/readme.md
@@ -2,43 +2,18 @@
 These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2. 
-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
-Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller  
+* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
-Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)  
+* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
 Make example for this keyboard (after setting up your build environment):
    make exclusive/e6v2/oe_bmc:default
-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make exclusive/e6v2/oe_bmc:default:flash
-**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. 
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
 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).
author	Joel Challis <git@zvecr.com>	2019-11-24 04:42:20 +0000
committer	James Young <18669334+noroadsleft@users.noreply.github.com>	2019-11-23 20:42:20 -0800
commit	6a8c0a6468f4e4ce48a59152418a226d0f027497 (patch)
tree	4937e648fb7d9afdf89fc6c4c92444ac90153fee /keyboards/exclusive/e6v2
parent	d14573620d3e964730af960aab3c05a5d061796f (diff)
download	qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.tar.gz qmk_firmware-6a8c0a6468f4e4ce48a59152418a226d0f027497.zip

diff --git a/keyboards/exclusive/e6v2/le_bmc/readme.md b/keyboards/exclusive/e6v2/le_bmc/readme.md index 4dc8e6ef5..561560a3e 100644 --- a/keyboards/exclusive/e6v2/le_bmc/readme.md +++ b/keyboards/exclusive/e6v2/le_bmc/readme.md
@@ -2,43 +2,18 @@
2		2
3	These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1.	3	These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1.
4		4
5	Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)	5	* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6	Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller	6	* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
7	Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)	7	* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
8		8
9	Make example for this keyboard (after setting up your build environment):	9	Make example for this keyboard (after setting up your build environment):
10		10
11	make exclusive/e6v2/le_bmc:default	11	make exclusive/e6v2/le_bmc:default
12		12
13	Flashing	13	Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14		14
15	ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.	15	make exclusive/e6v2/le_bmc:default:flash
16		16
17	Reset Key: Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard.	17	Reset Key: Hold down the key located at K00, commonly programmed as left control while plugging in the keyboard.
18
19	Windows:
20	1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
21	2. Place your keyboard into reset.
22	3. Press the `Find Device` button and ensure that your keyboard is found.
23	4. Press the `Open .hex File` button and locate the `.hex` file you created.
24	5. Press the `Flash Device` button and wait for the process to complete.
25
26	macOS:
27	1. Install homebrew by typing the following:
28	```
29	/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30	```
31	2. Install `crosspack-avr`.
32	```
33	brew cask install crosspack-avr
34	```
35	3. Install the following packages:
36	```
37	brew install python3
38	pip3 install pyusb
39	brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40	```
41	4. Place your keyboard into reset.
42	5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43		18
44	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).	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).


diff --git a/keyboards/exclusive/e6v2/oe_bmc/readme.md b/keyboards/exclusive/e6v2/oe_bmc/readme.md index a386abf6c..cd6da0ff0 100644 --- a/keyboards/exclusive/e6v2/oe_bmc/readme.md +++ b/keyboards/exclusive/e6v2/oe_bmc/readme.md
@@ -2,43 +2,18 @@
2		2
3	These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2.	3	These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2.
4		4
5	Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)	5	* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
6	Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller	6	* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
7	Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)	7	* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)
8		8
9	Make example for this keyboard (after setting up your build environment):	9	Make example for this keyboard (after setting up your build environment):
10		10
11	make exclusive/e6v2/oe_bmc:default	11	make exclusive/e6v2/oe_bmc:default
12		12
13	Flashing	13	Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
14		14
15	ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.	15	make exclusive/e6v2/oe_bmc:default:flash
16		16
17	Reset Key: Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard.	17	Reset Key: Hold down the key located at K00, commonly programmed as left control while plugging in the keyboard.
18
19	Windows:
20	1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
21	2. Place your keyboard into reset.
22	3. Press the `Find Device` button and ensure that your keyboard is found.
23	4. Press the `Open .hex File` button and locate the `.hex` file you created.
24	5. Press the `Flash Device` button and wait for the process to complete.
25
26	macOS:
27	1. Install homebrew by typing the following:
28	```
29	/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30	```
31	2. Install `crosspack-avr`.
32	```
33	brew cask install crosspack-avr
34	```
35	3. Install the following packages:
36	```
37	brew install python3
38	pip3 install pyusb
39	brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40
41	4. Place your keyboard into reset.
42	5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43		18
44	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).	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).