diff options
| author | Drashna Jaelre <drashna@live.com> | 2021-08-03 17:23:18 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-04 01:23:18 +0100 |
| commit | a0f2be18a40b157fc22720d127da9b312b1232bf (patch) | |
| tree | c5e9d18d98670ba53bb74915e99842dafa7a45e6 | |
| parent | 9c69db47000c84671abd9e567c124b6f1893cba5 (diff) | |
| download | qmk_firmware-a0f2be18a40b157fc22720d127da9b312b1232bf.tar.gz qmk_firmware-a0f2be18a40b157fc22720d127da9b312b1232bf.zip | |
Add bootloader section to keyboard template (#13774)
* Add bootloader section to keyboard template
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
| -rw-r--r-- | quantum/template/avr/readme.md | 8 | ||||
| -rw-r--r-- | quantum/template/ps2avrgb/readme.md | 11 |
2 files changed, 17 insertions, 2 deletions
diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md index fd14558420..b099ed726d 100644 --- a/quantum/template/avr/readme.md +++ b/quantum/template/avr/readme.md @@ -17,3 +17,11 @@ Flashing example for this keyboard: make %KEYBOARD%:default:flash 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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `RESET` if it is available diff --git a/quantum/template/ps2avrgb/readme.md b/quantum/template/ps2avrgb/readme.md index f19743a163..94063f9ebc 100644 --- a/quantum/template/ps2avrgb/readme.md +++ b/quantum/template/ps2avrgb/readme.md @@ -16,6 +16,13 @@ Flashing example for this keyboard ([after setting up the bootloadHID flashing e make %KEYBOARD%:default:flash -**Reset Key**: Hold down the key located at *LOCATION*, commonly programmed as *KEY* 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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **BootloadHID reset**: Hold down the key connected to the `A0` and `B0` pins on the MCU if it is known (often top left or bottom left) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `RESET` if it is available |