diff options
Diffstat (limited to 'docs/getting_started_docker.md')
| -rw-r--r-- | docs/getting_started_docker.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md index e5309fdbb..f9c3b366a 100644 --- a/docs/getting_started_docker.md +++ b/docs/getting_started_docker.md | |||
| @@ -4,8 +4,9 @@ This project includes a Docker workflow that will allow you to build a new firmw | |||
| 4 | 4 | ||
| 5 | ## Requirements | 5 | ## Requirements |
| 6 | 6 | ||
| 7 | The main prerequisite is a working `docker` install. | 7 | The main prerequisite is a working `docker` or `podman` install. |
| 8 | * [Docker CE](https://docs.docker.com/install/#supported-platforms) | 8 | * [Docker CE](https://docs.docker.com/install/#supported-platforms) |
| 9 | * [Podman](https://podman.io/getting-started/installation) | ||
| 9 | 10 | ||
| 10 | ## Usage | 11 | ## Usage |
| 11 | 12 | ||
| @@ -38,6 +39,13 @@ util/docker_build.sh | |||
| 38 | # Reads parameters as input (leave blank for all keyboards/keymaps) | 39 | # Reads parameters as input (leave blank for all keyboards/keymaps) |
| 39 | ``` | 40 | ``` |
| 40 | 41 | ||
| 42 | You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path. | ||
| 43 | By default docker or podman are automatically detected and docker is preferred over podman. | ||
| 44 | |||
| 45 | ```bash | ||
| 46 | RUNTIME="podman" util/docker_build.sh keyboard:keymap:target | ||
| 47 | ``` | ||
| 48 | |||
| 41 | ## FAQ | 49 | ## FAQ |
| 42 | 50 | ||
| 43 | ### Why can't I flash on Windows/macOS | 51 | ### Why can't I flash on Windows/macOS |