diff options
| author | Joel Challis <git@zvecr.com> | 2019-08-24 16:35:11 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-08-24 08:35:11 -0700 |
| commit | 51bcadf38cfccc08b287554ab17e21624abf55b8 (patch) | |
| tree | cf01c2e084befb908b6b4fb7ffa2002e4e4015b5 /docs/getting_started_make_guide.md | |
| parent | fb7c65dc34b3001617635e6afd10480f2770522d (diff) | |
| download | qmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.tar.gz qmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.zip | |
Add 'bootloadHID' flash target (#5587)
* Add 'bootloadHID' flash target
* Prep for flash target
* Add :flash support
* Align bootloader wait messages
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* Update template to suggest use of :flash
Diffstat (limited to 'docs/getting_started_make_guide.md')
| -rw-r--r-- | docs/getting_started_make_guide.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index 4fe3f184d..71e9d33f2 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
| @@ -14,7 +14,7 @@ The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, | |||
| 14 | The `<target>` means the following | 14 | The `<target>` means the following |
| 15 | * If no target is given, then it's the same as `all` below | 15 | * If no target is given, then it's the same as `all` below |
| 16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. | 16 | * `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. |
| 17 | * `dfu`, `teensy`, `avrdude` or `dfu-util`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. | 17 | * `dfu`, `teensy`, `avrdude`, `dfu-util` or `bootloadHID`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. |
| 18 | * **Note**: some operating systems need root access for these commands to work, so in that case you need to run for example `sudo make planck/rev4:default:dfu`. | 18 | * **Note**: some operating systems need root access for these commands to work, so in that case you need to run for example `sudo make planck/rev4:default:dfu`. |
| 19 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. | 19 | * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. |
| 20 | 20 | ||