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/getting_started_make_guide.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/getting_started_make_guide.md')
-rw-r--r-- | docs/getting_started_make_guide.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md index d1ecf6f5a..d2596b2e2 100644 --- a/docs/getting_started_make_guide.md +++ b/docs/getting_started_make_guide.md | |||
@@ -14,8 +14,8 @@ 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`, `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. | 17 | * `flash`, `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:flash`. |
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 | ||
21 | You can also add extra options at the end of the make command line, after the target | 21 | You can also add extra options at the end of the make command line, after the target |
@@ -31,7 +31,7 @@ Here are some examples commands | |||
31 | 31 | ||
32 | * `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. | 32 | * `make all:all` builds everything (all keyboard folders, all keymaps). Running just `make` from the `root` will also run this. |
33 | * `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. | 33 | * `make ergodox_infinity:algernon:clean` will clean the build output of the Ergodox Infinity keyboard. |
34 | * `make planck/rev4:default:dfu COLOR=false` builds and uploads the keymap without color output. | 34 | * `make planck/rev4:default:flash COLOR=false` builds and uploads the keymap without color output. |
35 | 35 | ||
36 | ## `rules.mk` Options | 36 | ## `rules.mk` Options |
37 | 37 | ||