From ccfe60eb57b6cb11c5c9914445cceae77c09c0da Mon Sep 17 00:00:00 2001
From: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
Date: Thu, 9 Aug 2018 17:45:43 -0700
Subject: Update ps2avrgb readme (#3599)

* give ps2avrgb a specific readme

* add homebrew and crosspack avr step

* update readme of all ps2avrgb boards to reflect the new template
---
 quantum/template/avr/readme.md      | 15 +++++++++++++
 quantum/template/base/readme.md     | 15 -------------
 quantum/template/ps2avrgb/readme.md | 44 +++++++++++++++++++++++++++++++++++++
 3 files changed, 59 insertions(+), 15 deletions(-)
 create mode 100644 quantum/template/avr/readme.md
 delete mode 100644 quantum/template/base/readme.md
 create mode 100644 quantum/template/ps2avrgb/readme.md

(limited to 'quantum/template')

diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md
new file mode 100644
index 0000000000..d9349811d0
--- /dev/null
+++ b/quantum/template/avr/readme.md
@@ -0,0 +1,15 @@
+# %KEYBOARD%
+
+![%KEYBOARD%](imgur.com image replace me!)
+
+A short description of the keyboard/project
+
+Keyboard Maintainer: [You](https://github.com/yourusername)  
+Hardware Supported: The PCBs, controllers supported  
+Hardware Availability: links to where you can find this hardware
+
+Make example for this keyboard (after setting up your build environment):
+
+    make %KEYBOARD%: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.
\ No newline at end of file
diff --git a/quantum/template/base/readme.md b/quantum/template/base/readme.md
deleted file mode 100644
index d9349811d0..0000000000
--- a/quantum/template/base/readme.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# %KEYBOARD%
-
-![%KEYBOARD%](imgur.com image replace me!)
-
-A short description of the keyboard/project
-
-Keyboard Maintainer: [You](https://github.com/yourusername)  
-Hardware Supported: The PCBs, controllers supported  
-Hardware Availability: links to where you can find this hardware
-
-Make example for this keyboard (after setting up your build environment):
-
-    make %KEYBOARD%: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.
\ No newline at end of file
diff --git a/quantum/template/ps2avrgb/readme.md b/quantum/template/ps2avrgb/readme.md
new file mode 100644
index 0000000000..1dcbe6e755
--- /dev/null
+++ b/quantum/template/ps2avrgb/readme.md
@@ -0,0 +1,44 @@
+# %KEYBOARD%
+
+![%KEYBOARD%](imgur.com image replace me!)
+
+A short description of the keyboard/project
+
+Keyboard Maintainer: [You](https://github.com/yourusername)  
+Hardware Supported: The PCBs, controllers supported  
+Hardware Availability: links to where you can find this hardware
+
+Make example for this keyboard (after setting up your build environment):
+
+    make %KEYBOARD%:default
+
+Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+
+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 python
+    brew 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 [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.
-- 
cgit v1.2.3