aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <[email protected]>2024-09-01 16:59:52 +0000
committerQMK Bot <[email protected]>2024-09-01 16:59:52 +0000
commit07535aa2c0272072334a082e0e1bc5d911ec6b85 (patch)
tree5c158f9fe95877b1eaf359cbe851d5522a23b3f4 /docs
parent784786c00c46098e25c82bfb1aa71aab8f3baace (diff)
parent884a808813fe9e5f90aab4079a5944997465161e (diff)
downloadqmk_firmware-07535aa2c0272072334a082e0e1bc5d911ec6b85.tar.gz
qmk_firmware-07535aa2c0272072334a082e0e1bc5d911ec6b85.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started_docker.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md
index 6e69b17d34..2d90d8566a 100644
--- a/docs/getting_started_docker.md
+++ b/docs/getting_started_docker.md
@@ -5,6 +5,7 @@ This project includes a Docker workflow that will allow you to build a new firmw
## Requirements
The main prerequisite is a working `docker` or `podman` install.
+
* [Docker CE](https://docs.docker.com/install/#supported-platforms)
* [Podman](https://podman.io/getting-started/installation)
@@ -18,6 +19,7 @@ cd qmk_firmware
```
Run the following command to build a keymap:
+
```
util/docker_build.sh <keyboard>:<keymap>
# For example: util/docker_build.sh planck/rev6:default
@@ -32,6 +34,8 @@ util/docker_build.sh keyboard:keymap:target
# For example: util/docker_build.sh planck/rev6:default:flash
```
+Note that mass storage bootloaders are not supported by the `flash` target. In this case you will have to manually copy the firmware file to the keyboard.
+
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:
```