aboutsummaryrefslogtreecommitdiff
path: root/docs/getting_started_build_tools.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting_started_build_tools.md')
-rw-r--r--docs/getting_started_build_tools.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md
index 67bbe5434..375e9d108 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -123,24 +123,27 @@ If you have trouble and want to ask for help, it is useful to generate a *Win_Ch
123 123
124## Docker 124## Docker
125 125
126If this is a bit complex for you, Docker might be the turn-key solution you need. After installing [Docker](https://www.docker.com/products/docker), run the following command at the root of the QMK folder to build a keyboard/keymap: 126If this is a bit complex for you, Docker might be the turn-key solution you need. After installing [Docker CE](https://docs.docker.com/install/#supported-platforms), run the following command from the `qmk_firmware` directory to build a keyboard/keymap:
127
128```bash 127```bash
129# You'll run this every time you want to build a keymap 128util/docker_build.sh keyboard:keymap
130# modify the keymap and keyboard assignment to compile what you want 129# For example: util/docker_build.sh ergodox_ez:steno
131# defaults are ergodox/default
132
133docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
134``` 130```
131This will compile the targeted keyboard/keymap and leave the resulting `.hex` or `.bin` file in the QMK directory for you to flash. If `:keymap` is omitted, the `default` keymap is used. Note that the parameter format is the same as when building with `make`.
135 132
136On Windows Docker seems to have issues with the VOLUME tag in Dockerfile, and `$('pwd')` won't print a Windows compliant path; use full path instead, like this: 133You 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:
137
138```bash 134```bash
139docker run -e keymap=default -e keyboard=ergodox_ez --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware 135util/docker_build.sh
136# Reads parameters as input (leave blank for defaults)
137```
140 138
139There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well:
140```bash
141util/docker_build.sh keyboard:keymap:target
142# For example: util/docker_build.sh planck/rev6:default:dfu-util
141``` 143```
144If you're on Linux, this should work out of the box. On Windows and macOS, it requires [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/) to be running. This is tedious to set up, so it's not recommended; use QMK Toolbox instead.
142 145
143This will compile the targeted keyboard/keymap and leave it in your QMK directory for you to flash. 146!> Docker for Windows requires [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) to be enabled. This means that it cannot work on versions of Windows which don't have Hyper-V, such as Windows 7, Windows 8 and **Windows 10 Home**.
144 147
145## Vagrant 148## Vagrant
146If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [vagrant guide](getting_started_vagrant.md). 149If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [vagrant guide](getting_started_vagrant.md).