diff options
author | Zach White <skullydazed@gmail.com> | 2021-01-16 15:13:04 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-16 15:13:04 -0800 |
commit | d9785ec31339d7f80279fd3d1005f76689ed2f6a (patch) | |
tree | 01f9e771367cfcd18d347eef7f85ce78a3b5ba50 /docs | |
parent | c628408688306ed3e970505268cc4a235af8a5ff (diff) | |
download | qmk_firmware-d9785ec31339d7f80279fd3d1005f76689ed2f6a.tar.gz qmk_firmware-d9785ec31339d7f80279fd3d1005f76689ed2f6a.zip |
Improve the compile and flash subcommands (#11334)
* add support for --clean to compile and flash
* compile standalone JSON keymaps without polluting the tree
* Add support for passing environment vars to make
* make flake8 happy
* document changes to qmk compile and flash
* add -e support to json export compiling
* Fix python 3.6
* honor $MAKE
* add support for parallel builds
Diffstat (limited to 'docs')
-rw-r--r-- | docs/cli_commands.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 61ce1aa2a..5ab49abd2 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
@@ -11,13 +11,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
11 | **Usage for Configurator Exports**: | 11 | **Usage for Configurator Exports**: |
12 | 12 | ||
13 | ``` | 13 | ``` |
14 | qmk compile <configuratorExport.json> | 14 | qmk compile [-c] <configuratorExport.json> |
15 | ``` | 15 | ``` |
16 | 16 | ||
17 | **Usage for Keymaps**: | 17 | **Usage for Keymaps**: |
18 | 18 | ||
19 | ``` | 19 | ``` |
20 | qmk compile -kb <keyboard_name> -km <keymap_name> | 20 | qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name> |
21 | ``` | 21 | ``` |
22 | 22 | ||
23 | **Usage in Keyboard Directory**: | 23 | **Usage in Keyboard Directory**: |
@@ -82,13 +82,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
82 | **Usage for Configurator Exports**: | 82 | **Usage for Configurator Exports**: |
83 | 83 | ||
84 | ``` | 84 | ``` |
85 | qmk flash <configuratorExport.json> -bl <bootloader> | 85 | qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json> |
86 | ``` | 86 | ``` |
87 | 87 | ||
88 | **Usage for Keymaps**: | 88 | **Usage for Keymaps**: |
89 | 89 | ||
90 | ``` | 90 | ``` |
91 | qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader> | 91 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] |
92 | ``` | 92 | ``` |
93 | 93 | ||
94 | **Listing the Bootloaders** | 94 | **Listing the Bootloaders** |