Skip to content

Commit

Permalink
doc: "docker getting started" mentions flash limitations (qmk#24336)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
2 people authored and itsme-zeix committed Oct 2, 2024
1 parent 8d007f3 commit 6eb7463
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/getting_started_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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
Expand All @@ -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:

```
Expand Down

0 comments on commit 6eb7463

Please sign in to comment.