varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity

doc: "docker getting started" mentions flash limitations (#24336)

Browse source 
* 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 <18669334+noroadsleft@users.noreply.github.com>

---------

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
This commit is contained in:
Stefan Otte 2024-09-01 18:59:21 +02:00 committed by GitHub
parent fba0408cb3
commit 884a808813
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/getting_started_docker.md
View file

@ -5,6 +5,7 @@ This project includes a Docker workflow that will allow you to build a new firmw
## Requirements ## Requirements
The main prerequisite is a working `docker` or `podman` install. The main prerequisite is a working `docker` or `podman` install.
* [Docker CE](https://docs.docker.com/install/#supported-platforms) * [Docker CE](https://docs.docker.com/install/#supported-platforms)
* [Podman](https://podman.io/getting-started/installation) * [Podman](https://podman.io/getting-started/installation)
@ -18,6 +19,7 @@ cd qmk_firmware
``` ```
Run the following command to build a keymap: Run the following command to build a keymap:
``` ```
util/docker_build.sh <keyboard>:<keymap> util/docker_build.sh <keyboard>:<keymap>
# For example: util/docker_build.sh planck/rev6:default # 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 # 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: 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:
``` ```