diff options
| author | James Young <xxiinophobia@yahoo.com> | 2020-02-20 19:00:42 -0800 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
| commit | 3c98854044066744ad79d8abc27d93951860af6d (patch) | |
| tree | d2b3dcaaa267fa33793120e16e525a13cb39b195 | |
| parent | 7b1b53054f5563c9378193af86d7fae913f67e68 (diff) | |
| download | qmk_firmware-3c98854044066744ad79d8abc27d93951860af6d.tar.gz qmk_firmware-3c98854044066744ad79d8abc27d93951860af6d.zip | |
update flashing.md
- minor typo on intro paragraph (the -> them)
- remove note about :check-size target (`make` task now does this automatically)
- heading level for Caterina commands section
- typo regarding Halfkay (come -> comes)
| -rw-r--r-- | docs/flashing.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index 98841c1aa..ab003308d 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
| @@ -1,8 +1,8 @@ | |||
| 1 | # Flashing Instructions and Bootloader Information | 1 | # Flashing Instructions and Bootloader Information |
| 2 | 2 | ||
| 3 | There are quite a few different types of bootloaders that keyboards use, and just about all of the use a different flashing method. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them. | 3 | There are quite a few different types of bootloaders that keyboards use, and just about all of them use a different flashing method. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them. |
| 4 | 4 | ||
| 5 | If you have a bootloader selected with the `BOOTLOADER` variable in your `rules.mk`, QMK will automatically calculate if your .hex file is the right size to be flashed to the device, and output the total size in bytes (along with the max). To run this process manually, compile with the target `check-size`, eg `make planck/rev4:default:check-size`. | 5 | If you have a bootloader selected with the `BOOTLOADER` variable in your `rules.mk`, QMK will automatically calculate if your .hex file is the right size to be flashed to the device, and output the total size in bytes (along with the max). |
| 6 | 6 | ||
| 7 | ## DFU | 7 | ## DFU |
| 8 | 8 | ||
| @@ -100,7 +100,7 @@ or | |||
| 100 | make <keyboard>:<keymap>:avrdude | 100 | make <keyboard>:<keymap>:avrdude |
| 101 | 101 | ||
| 102 | 102 | ||
| 103 | #### Caterina commands | 103 | ### Caterina commands |
| 104 | 104 | ||
| 105 | There are a number of DFU commands that you can use to flash firmware to a DFU device: | 105 | There are a number of DFU commands that you can use to flash firmware to a DFU device: |
| 106 | 106 | ||
| @@ -113,7 +113,7 @@ There are a number of DFU commands that you can use to flash firmware to a DFU d | |||
| 113 | 113 | ||
| 114 | ## Halfkay | 114 | ## Halfkay |
| 115 | 115 | ||
| 116 | Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0). | 116 | Halfkay is a super-slim protocol developed by PJRC that uses HID, and comes on all Teensys (namely the 2.0). |
| 117 | 117 | ||
| 118 | To ensure compatibility with the Halfkay bootloader, make sure this block is present your `rules.mk`: | 118 | To ensure compatibility with the Halfkay bootloader, make sure this block is present your `rules.mk`: |
| 119 | 119 | ||