diff options
| -rw-r--r-- | keyboards/bfake/readme.md | 32 | ||||
| -rw-r--r-- | keyboards/bmini/readme.md | 32 | ||||
| -rw-r--r-- | keyboards/canoe/readme.md | 30 | ||||
| -rw-r--r-- | keyboards/facew/readme.md | 31 | ||||
| -rw-r--r-- | keyboards/singa/readme.md | 30 | ||||
| -rw-r--r-- | quantum/template/avr/readme.md (renamed from quantum/template/base/readme.md) | 0 | ||||
| -rw-r--r-- | quantum/template/ps2avrgb/readme.md | 44 |
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 | ||
| 14 | 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 | 14 | Flashing |
| 15 | |||
| 16 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 17 | |||
| 18 | Windows: | ||
| 19 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 20 | 2. Place your keyboard into reset. | ||
| 21 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 22 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 23 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 24 | |||
| 25 | macOS: | ||
| 26 | 1. Install homebrew by typing the following: | ||
| 27 | ``` | ||
| 28 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 29 | ``` | ||
| 30 | 2. Install `crosspack-avr`. | ||
| 31 | ``` | ||
| 32 | brew cask install crosspack-avr | ||
| 33 | ``` | ||
| 34 | 3. 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 | |||
| 40 | 4. Place your keyboard into reset. | ||
| 41 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 42 | |||
| 43 | |||
| 44 | 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. | ||
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 | ||
| 14 | 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 | 14 | Flashing |
| 15 | |||
| 16 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 17 | |||
| 18 | Windows: | ||
| 19 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 20 | 2. Place your keyboard into reset. | ||
| 21 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 22 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 23 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 24 | |||
| 25 | macOS: | ||
| 26 | 1. Install homebrew by typing the following: | ||
| 27 | ``` | ||
| 28 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 29 | ``` | ||
| 30 | 2. Install `crosspack-avr`. | ||
| 31 | ``` | ||
| 32 | brew cask install crosspack-avr | ||
| 33 | ``` | ||
| 34 | 3. 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 | |||
| 40 | 4. Place your keyboard into reset. | ||
| 41 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 42 | |||
| 43 | |||
| 44 | 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. | ||
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 | ||
| 14 | Flashing | ||
| 15 | |||
| 16 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 17 | |||
| 18 | Windows: | ||
| 19 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 20 | 2. Place your keyboard into reset. | ||
| 21 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 22 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 23 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 24 | |||
| 25 | macOS: | ||
| 26 | 1. Install homebrew by typing the following: | ||
| 27 | ``` | ||
| 28 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 29 | ``` | ||
| 30 | 2. Install `crosspack-avr`. | ||
| 31 | ``` | ||
| 32 | brew cask install crosspack-avr | ||
| 33 | ``` | ||
| 34 | 3. 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 | |||
| 40 | 4. Place your keyboard into reset. | ||
| 41 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 42 | |||
| 43 | |||
| 14 | 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. | 44 | 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. |
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 | ||
| 20 | Make example for this keyboard (after setting up your build environment): | 19 | Make example for this keyboard (after setting up your build environment): |
| 21 | 20 | ||
| 22 | make facew:default | 21 | make facew:default |
| 23 | 22 | ||
| 23 | Flashing | ||
| 24 | |||
| 25 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 26 | |||
| 27 | Windows: | ||
| 28 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 29 | 2. Place your keyboard into reset. | ||
| 30 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 31 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 32 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 33 | |||
| 34 | macOS: | ||
| 35 | 1. Install homebrew by typing the following: | ||
| 36 | ``` | ||
| 37 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 38 | ``` | ||
| 39 | 2. Install `crosspack-avr`. | ||
| 40 | ``` | ||
| 41 | brew cask install crosspack-avr | ||
| 42 | ``` | ||
| 43 | 3. 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 | |||
| 49 | 4. Place your keyboard into reset. | ||
| 50 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 51 | |||
| 52 | |||
| 24 | 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. | 53 | 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. |
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 | ||
| 19 | Flashing | ||
| 20 | |||
| 21 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 22 | |||
| 23 | Windows: | ||
| 24 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 25 | 2. Place your keyboard into reset. | ||
| 26 | 3. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 27 | 4. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 28 | 5. Press the `Flash Device` button and wait for the process to complete. | ||
| 29 | |||
| 30 | macOS: | ||
| 31 | 1. Install homebrew by typing the following: | ||
| 32 | ``` | ||
| 33 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 34 | ``` | ||
| 35 | 2. Install `crosspack-avr`. | ||
| 36 | ``` | ||
| 37 | brew cask install crosspack-avr | ||
| 38 | ``` | ||
| 39 | 3. 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 | |||
| 45 | 4. Place your keyboard into reset. | ||
| 46 | 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 47 | |||
| 48 | |||
| 19 | 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. | 49 | 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. |
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 |  | ||
| 4 | |||
| 5 | A short description of the keyboard/project | ||
| 6 | |||
| 7 | Keyboard Maintainer: [You](https://github.com/yourusername) | ||
| 8 | Hardware Supported: The PCBs, controllers supported | ||
| 9 | Hardware Availability: links to where you can find this hardware | ||
| 10 | |||
| 11 | Make example for this keyboard (after setting up your build environment): | ||
| 12 | |||
| 13 | make %KEYBOARD%:default | ||
| 14 | |||
| 15 | Flashing | ||
| 16 | |||
| 17 | ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 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 python | ||
| 38 | brew 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 | |||
| 44 | 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. | ||
