diff options
| author | Ryan <fauxpark@gmail.com> | 2021-09-14 22:16:24 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-14 13:16:24 +0100 |
| commit | b56282756b5faa410301de8c4ecdcae0e0148652 (patch) | |
| tree | cf68cfe0e4f148d6eab52ae289ce261bea88f6c3 /docs/getting_started_docker.md | |
| parent | 0ca4a56a0449d17a497ba610d4cee41c914ff50e (diff) | |
[Docs] Clean up some code block languages (#14434)
Diffstat (limited to 'docs/getting_started_docker.md')
| -rw-r--r-- | docs/getting_started_docker.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md index f9c3b366a4..c4da8af968 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. Acquire a local copy of the QMK's repository (including submodules): -```bash +``` git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git cd qmk_firmware ``` Run the following command to build a keymap: -```bash +``` util/docker_build.sh <keyboard>:<keymap> # For example: util/docker_build.sh planck/rev6:default ``` @@ -27,14 +27,14 @@ This will compile the desired keyboard/keymap and leave the resulting `.hex` or There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: -```bash +``` util/docker_build.sh keyboard:keymap:target # For example: util/docker_build.sh planck/rev6:default:flash ``` You 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: -```bash +``` util/docker_build.sh # Reads parameters as input (leave blank for all keyboards/keymaps) ``` @@ -42,7 +42,7 @@ util/docker_build.sh You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path. By default docker or podman are automatically detected and docker is preferred over podman. -```bash +``` RUNTIME="podman" util/docker_build.sh keyboard:keymap:target ``` |