diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md index 6e69b17d347..2d90d8566ab 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 : # 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: ```