aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_build_tools.md
diff options
context:
space:
mode:
authorshela <shelaf@users.noreply.github.com>2020-01-10 09:44:16 +0900
committerJoel Challis <git@zvecr.com>2020-01-10 00:44:16 +0000
commit5a02cc00a43cbeb9cc6ad94811acfb861d8f3929 (patch)
tree7bdb0d8758e1ae5fd046346907c9f8315b983e55 /docs/getting_started_build_tools.md
parent886eb98e2ae070019dc8032d93d4c751d3588a67 (diff)
downloadqmk_firmware-5a02cc00a43cbeb9cc6ad94811acfb861d8f3929.tar.gz
qmk_firmware-5a02cc00a43cbeb9cc6ad94811acfb861d8f3929.zip
Fix docker script and document (#7786)
Fixed error when keyboard parameter is omitted in interactive mode.
Diffstat (limited to 'docs/getting_started_build_tools.md')
-rw-r--r--docs/getting_started_build_tools.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md
index 95f17e4b2..fea20e59b 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -120,12 +120,12 @@ If this is a bit complex for you, Docker might be the turnkey solution you need.
120util/docker_build.sh keyboard:keymap 120util/docker_build.sh keyboard:keymap
121# For example: util/docker_build.sh ergodox_ez:steno 121# For example: util/docker_build.sh ergodox_ez:steno
122``` 122```
123This will compile the desired keyboard/keymap and leave the resulting `.hex` or `.bin` file in the QMK directory for you to flash. If `:keymap` is omitted, the `default` keymap is used. Note that the parameter format is the same as when building with `make`. 123This will compile the desired keyboard/keymap and leave the resulting `.hex` or `.bin` file in the QMK directory for you to flash. If `:keymap` is omitted, all keymaps are used. Note that the parameter format is the same as when building with `make`.
124 124
125You can also start the script without any parameters, in which case it will ask you to input the build parameters one by one, which you may find easier to use: 125You can also start the script without any parameters, in which case it will ask you to input the build parameters one by one, which you may find easier to use:
126```bash 126```bash
127util/docker_build.sh 127util/docker_build.sh
128# Reads parameters as input (leave blank for defaults) 128# Reads parameters as input (leave blank for all keyboards/keymaps)
129``` 129```
130 130
131There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: 131There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: