aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-08-09 17:45:43 -0700
committerDrashna Jaelre <drashna@live.com>2018-08-09 17:45:43 -0700
commitccfe60eb57b6cb11c5c9914445cceae77c09c0da (patch)
tree772dd3b83192a0c45fabdb9c92b3f39a78225b53
parent435e9b7bdb89043b3ce8b0cfc9b0f3ee4d298166 (diff)
downloadqmk_firmware-ccfe60eb57b6cb11c5c9914445cceae77c09c0da.tar.gz
qmk_firmware-ccfe60eb57b6cb11c5c9914445cceae77c09c0da.zip
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
-rw-r--r--keyboards/bfake/readme.md32
-rw-r--r--keyboards/bmini/readme.md32
-rw-r--r--keyboards/canoe/readme.md30
-rw-r--r--keyboards/facew/readme.md31
-rw-r--r--keyboards/singa/readme.md30
-rw-r--r--quantum/template/avr/readme.md (renamed from quantum/template/base/readme.md)0
-rw-r--r--quantum/template/ps2avrgb/readme.md44
7 files changed, 196 insertions, 3 deletions
diff --git a/keyboards/bfake/readme.md b/keyboards/bfake/readme.md
index 47db91498..ca12b4996 100644
--- a/keyboards/bfake/readme.md
+++ b/keyboards/bfake/readme.md
@@ -11,4 +11,34 @@ Make example for this keyboard (after setting up your build environment):
11 11
12 make bfake:default 12 make bfake:default
13 13
14See [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 14Flashing
15
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
17
18Windows:
191. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
202. Place your keyboard into reset.
213. Press the `Find Device` button and ensure that your keyboard is found.
224. Press the `Open .hex File` button and locate the `.hex` file you created.
235. Press the `Flash Device` button and wait for the process to complete.
24
25macOS:
261. Install homebrew by typing the following:
27 ```
28 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
29 ```
302. Install `crosspack-avr`.
31 ```
32 brew cask install crosspack-avr
33 ```
343. Install the following packages:
35 ```
36 brew install python
37 brew install pyusb
38 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42
43
44See [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.
diff --git a/keyboards/bmini/readme.md b/keyboards/bmini/readme.md
index 01017e175..38dc49307 100644
--- a/keyboards/bmini/readme.md
+++ b/keyboards/bmini/readme.md
@@ -11,4 +11,34 @@ Make example for this keyboard (after setting up your build environment):
11 11
12 make bmini:default 12 make bmini:default
13 13
14See [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 14Flashing
15
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
17
18Windows:
191. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
202. Place your keyboard into reset.
213. Press the `Find Device` button and ensure that your keyboard is found.
224. Press the `Open .hex File` button and locate the `.hex` file you created.
235. Press the `Flash Device` button and wait for the process to complete.
24
25macOS:
261. Install homebrew by typing the following:
27 ```
28 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
29 ```
302. Install `crosspack-avr`.
31 ```
32 brew cask install crosspack-avr
33 ```
343. Install the following packages:
35 ```
36 brew install python
37 brew install pyusb
38 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42
43
44See [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.
diff --git a/keyboards/canoe/readme.md b/keyboards/canoe/readme.md
index 4a83efd82..f58ffe4fd 100644
--- a/keyboards/canoe/readme.md
+++ b/keyboards/canoe/readme.md
@@ -11,4 +11,34 @@ Make example for this keyboard (after setting up your build environment):
11 11
12 make canoe:default 12 make canoe:default
13 13
14Flashing
15
16ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
17
18Windows:
191. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
202. Place your keyboard into reset.
213. Press the `Find Device` button and ensure that your keyboard is found.
224. Press the `Open .hex File` button and locate the `.hex` file you created.
235. Press the `Flash Device` button and wait for the process to complete.
24
25macOS:
261. Install homebrew by typing the following:
27 ```
28 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
29 ```
302. Install `crosspack-avr`.
31 ```
32 brew cask install crosspack-avr
33 ```
343. Install the following packages:
35 ```
36 brew install python
37 brew install pyusb
38 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
39
404. Place your keyboard into reset.
415. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
42
43
14See [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. 44See [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.
diff --git a/keyboards/facew/readme.md b/keyboards/facew/readme.md
index 727c04d93..f948e7a46 100644
--- a/keyboards/facew/readme.md
+++ b/keyboards/facew/readme.md
@@ -15,10 +15,39 @@ Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_
15- The FaceW Sprit Edition can be purchased on [mechanicalkeyboards.com](www.mechanicalkeyboards.com) 15- The FaceW Sprit Edition can be purchased on [mechanicalkeyboards.com](www.mechanicalkeyboards.com)
16- Uses ps2avru instead of ps2avrgb 16- Uses ps2avru instead of ps2avrgb
17- To put in reset mode hold `q` while inserting the USB cable 17- To put in reset mode hold `q` while inserting the USB cable
18- When flashing, type `bootloadHID -r yourfile.hex` and wait awhile
19 18
20Make example for this keyboard (after setting up your build environment): 19Make example for this keyboard (after setting up your build environment):
21 20
22 make facew:default 21 make facew:default
23 22
23Flashing
24
25ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
26
27Windows:
281. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
292. Place your keyboard into reset.
303. Press the `Find Device` button and ensure that your keyboard is found.
314. Press the `Open .hex File` button and locate the `.hex` file you created.
325. Press the `Flash Device` button and wait for the process to complete.
33
34macOS:
351. Install homebrew by typing the following:
36 ```
37 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
38 ```
392. Install `crosspack-avr`.
40 ```
41 brew cask install crosspack-avr
42 ```
433. Install the following packages:
44 ```
45 brew install python
46 brew install pyusb
47 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
48
494. Place your keyboard into reset.
505. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
51
52
24See [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. 53See [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.
diff --git a/keyboards/singa/readme.md b/keyboards/singa/readme.md
index c0325d1a0..09b540722 100644
--- a/keyboards/singa/readme.md
+++ b/keyboards/singa/readme.md
@@ -16,4 +16,34 @@ Make example for this keyboard (after setting up your build environment):
16 16
17 make singa:default 17 make singa:default
18 18
19Flashing
20
21ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
22
23Windows:
241. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
252. Place your keyboard into reset.
263. Press the `Find Device` button and ensure that your keyboard is found.
274. Press the `Open .hex File` button and locate the `.hex` file you created.
285. Press the `Flash Device` button and wait for the process to complete.
29
30macOS:
311. Install homebrew by typing the following:
32 ```
33 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
34 ```
352. Install `crosspack-avr`.
36 ```
37 brew cask install crosspack-avr
38 ```
393. Install the following packages:
40 ```
41 brew install python
42 brew install pyusb
43 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
44
454. Place your keyboard into reset.
465. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
47
48
19See [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. 49See [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.
diff --git a/quantum/template/base/readme.md b/quantum/template/avr/readme.md
index d9349811d..d9349811d 100644
--- a/quantum/template/base/readme.md
+++ b/quantum/template/avr/readme.md
diff --git a/quantum/template/ps2avrgb/readme.md b/quantum/template/ps2avrgb/readme.md
new file mode 100644
index 000000000..1dcbe6e75
--- /dev/null
+++ b/quantum/template/ps2avrgb/readme.md
@@ -0,0 +1,44 @@
1# %KEYBOARD%
2
3![%KEYBOARD%](imgur.com image replace me!)
4
5A short description of the keyboard/project
6
7Keyboard Maintainer: [You](https://github.com/yourusername)
8Hardware Supported: The PCBs, controllers supported
9Hardware Availability: links to where you can find this hardware
10
11Make example for this keyboard (after setting up your build environment):
12
13 make %KEYBOARD%:default
14
15Flashing
16
17ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
18
19Windows:
201. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
212. Place your keyboard into reset.
223. Press the `Find Device` button and ensure that your keyboard is found.
234. Press the `Open .hex File` button and locate the `.hex` file you created.
245. Press the `Flash Device` button and wait for the process to complete.
25
26macOS:
271. Install homebrew by typing the following:
28 ```
29 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
30 ```
312. Install `crosspack-avr`.
32 ```
33 brew cask install crosspack-avr
34 ```
353. Install the following packages:
36 ```
37 brew install python
38 brew install pyusb
39 brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
40
414. Place your keyboard into reset.
425. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
43
44See [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.