drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Docs] Clean up some code block languages (#14434)

Browse source
This commit is contained in:
Ryan 2021-09-14 22:16:24 +10:00 • committed by GitHub
parent 0ca4a56a04
commit b56282756b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 61 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/getting_started_docker.md
View file

@ -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
```