diff options
author | Drashna Jaelre <drashna@live.com> | 2019-10-29 13:15:03 -0700 |
---|---|---|
committer | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2019-10-29 13:15:03 -0700 |
commit | 0e6f78547eca1e7bbb093265e79c26a301e6635a (patch) | |
tree | 9bd2ae7a3ffb6d18e098fed96deee1d3c1cee3b0 /docs/flashing.md | |
parent | 476f5566132032af227a4fa95ceab56f4f3e06f7 (diff) | |
download | qmk_firmware-0e6f78547eca1e7bbb093265e79c26a301e6635a.tar.gz qmk_firmware-0e6f78547eca1e7bbb093265e79c26a301e6635a.zip |
[Docs] Update flashing information to include :flash target (#6999)
* Update Newbs Flashing guide
For the newbs that want to start flashing
* Update flashing docs
* Misc flashing
* Attempt at flashing in french
Lets hope I didn't butcher this too badly with machine transations
* Update docs/feature_userspace.md
* Apply language suggestions from code review
* Apply suggestions from code review
* Apply additional fr lang suggestions from code review
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch>
Co-Authored-By: Xavier Hahn <xavier.hahn@gmail.com>
Co-Authored-By: Vincent LE GOFF <vince.legoff@gmail.com>
Diffstat (limited to 'docs/flashing.md')
-rw-r--r-- | docs/flashing.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index 18ae6364d..98841c1aa 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
@@ -99,11 +99,16 @@ or | |||
99 | 99 | ||
100 | make <keyboard>:<keymap>:avrdude | 100 | make <keyboard>:<keymap>:avrdude |
101 | 101 | ||
102 | or if you want to flash multiple boards, use the following command | ||
103 | 102 | ||
104 | make <keyboard>:<keymap>:avrdude-loop | 103 | #### Caterina commands |
104 | |||
105 | There are a number of DFU commands that you can use to flash firmware to a DFU device: | ||
106 | |||
107 | * `:avrdude` - This is the normal option which waits until a Caterina device is available (by detecting a new COM port), and then flashes the firmware. | ||
108 | * `:avrdude-loop` - This runs the same command as `:avrdude`, but after each device is flashed, it will attempt to flash again. This is useful for bulk flashing. _This requires you to manually escape the loop by hitting Ctrl+C._ | ||
109 | * `:avrdude-split-left` - This flashes the normal firmware, just like the default option (`:avrdude`). However, this also flashes the "Left Side" EEPROM file for split keyboards. _This is ideal for Pro Micro based split keyboards._ | ||
110 | * `:avrdude-split-right` - This flashes the normal firmware, just like the default option (`:avrdude`). However, this also flashes the "Right Side" EEPROM file for split keyboards. _This is ideal for Pro Micro based split keyboards._ | ||
105 | 111 | ||
106 | When you're done flashing boards, you'll need to hit Ctrl + C or whatever the correct keystroke is for your operating system to break the loop. | ||
107 | 112 | ||
108 | 113 | ||
109 | ## Halfkay | 114 | ## Halfkay |
@@ -231,7 +236,7 @@ Flashing sequence: | |||
231 | 236 | ||
232 | There are a number of DFU commands that you can use to flash firmware to a STM32 device: | 237 | There are a number of DFU commands that you can use to flash firmware to a STM32 device: |
233 | 238 | ||
234 | * `:dfu-util` - The default command for flashing to STM32 devices. | 239 | * `:dfu-util` - The default command for flashing to STM32 devices, and will wait until an STM32 bootloader device is present. |
235 | * `:dfu-util-split-left` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Left Side" EEPROM setting for split keyboards. | 240 | * `:dfu-util-split-left` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Left Side" EEPROM setting for split keyboards. |
236 | * `:dfu-util-split-right` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Right Side" EEPROM setting for split keyboards. | 241 | * `:dfu-util-split-right` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Right Side" EEPROM setting for split keyboards. |
237 | * `:st-link-cli` - This allows you to flash the firmware via ST-LINK's CLI utility, rather than dfu-util. | 242 | * `:st-link-cli` - This allows you to flash the firmware via ST-LINK's CLI utility, rather than dfu-util. |