aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_docker.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting_started_docker.md')
-rw-r--r--docs/getting_started_docker.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md
index f9c3b366a..c4da8af96 100644
--- a/docs/getting_started_docker.md
+++ b/docs/getting_started_docker.md
@@ -12,13 +12,13 @@ The main prerequisite is a working `docker` or `podman` install.
12 12
13Acquire a local copy of the QMK's repository (including submodules): 13Acquire a local copy of the QMK's repository (including submodules):
14 14
15```bash 15```
16git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git 16git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git
17cd qmk_firmware 17cd qmk_firmware
18``` 18```
19 19
20Run the following command to build a keymap: 20Run the following command to build a keymap:
21```bash 21```
22util/docker_build.sh <keyboard>:<keymap> 22util/docker_build.sh <keyboard>:<keymap>
23# For example: util/docker_build.sh planck/rev6:default 23# For example: util/docker_build.sh planck/rev6:default
24``` 24```
@@ -27,14 +27,14 @@ This will compile the desired keyboard/keymap and leave the resulting `.hex` or
27 27
28There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: 28There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well:
29 29
30```bash 30```
31util/docker_build.sh keyboard:keymap:target 31util/docker_build.sh keyboard:keymap:target
32# For example: util/docker_build.sh planck/rev6:default:flash 32# For example: util/docker_build.sh planck/rev6:default:flash
33``` 33```
34 34
35You 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: 35You 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:
36 36
37```bash 37```
38util/docker_build.sh 38util/docker_build.sh
39# Reads parameters as input (leave blank for all keyboards/keymaps) 39# Reads parameters as input (leave blank for all keyboards/keymaps)
40``` 40```
@@ -42,7 +42,7 @@ util/docker_build.sh
42You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path. 42You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path.
43By default docker or podman are automatically detected and docker is preferred over podman. 43By default docker or podman are automatically detected and docker is preferred over podman.
44 44
45```bash 45```
46RUNTIME="podman" util/docker_build.sh keyboard:keymap:target 46RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
47``` 47```
48 48