summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-02-28 05:00:12 +0000
committerQMK Bot <hello@qmk.fm>2021-02-28 05:00:12 +0000
commit33c7d6eb9390e263f985928d101fe8cced70121b (patch)
tree5a36046bb90e7849a14a8a28a54cbbbbc3ac776c /docs
parent9525d5b5aebf829ed91f157914ac7fd11182fc92 (diff)
parente4d3ff2374142fe6431b68874f6604a471732fae (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/getting_started_docker.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/getting_started_docker.md b/docs/getting_started_docker.md
index e5309fdbbf..f9c3b366a4 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
## Requirements
-The main prerequisite is a working `docker` install.
+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)
## Usage
@@ -38,6 +39,13 @@ util/docker_build.sh
# Reads parameters as input (leave blank for all keyboards/keymaps)
```
+You can manually set which container runtime you want to use by setting the `RUNTIME` environment variable to it's name or path.
+By default docker or podman are automatically detected and docker is preferred over podman.
+
+```bash
+RUNTIME="podman" util/docker_build.sh keyboard:keymap:target
+```
+
## FAQ
### Why can't I flash on Windows/macOS