aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Otte <[email protected]>2024-09-01 18:59:21 +0200
committerGitHub <[email protected]>2024-09-01 10:59:21 -0600
commit884a808813fe9e5f90aab4079a5944997465161e (patch)
treee2b2e086d15409bba77e4bbd661cbfbd60da914d
parentfba0408cb3735867167cfd3e990e0cbd7f58d165 (diff)
downloadqmk_firmware-884a808813fe9e5f90aab4079a5944997465161e.tar.gz
qmk_firmware-884a808813fe9e5f90aab4079a5944997465161e.zip
doc: "docker getting started" mentions `flash` limitations (#24336)
* doc: "docker getting started" mentions `flash` limitations Mass storage bootloader don't work with `flash` target. * Update docs/getting_started_docker.md Co-authored-by: James Young <[email protected]> --------- Co-authored-by: James Young <[email protected]>
-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:
```