qmk

Unnamed repository; edit this file 'description' to name the repository.
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

commit cd369b710796505fb0dbcfafed546597eee3786d
parent cc146e32dcc32c0213c501d734c8c9d61c974ee5
Author: Konstantin Đorđević <vomindoraan@gmail.com>
Date:   Fri, 15 Feb 2019 15:46:42 +0100

docker_build.sh: Run container in interactive mode (#5088)

* docker_build.sh: Run container in interactive mode

* Add message about QMK Toolbox

* Update Docker docs

Diffstat:
docs/getting_started_build_tools.md | 8++++----
util/docker_build.sh | 3++-
2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md @@ -129,12 +129,12 @@ If you have trouble and want to ask for help, it is useful to generate a *Win_Ch ## Docker -If 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: +If this is a bit complex for you, Docker might be the turnkey 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: ```bash -util/docker_build.sh keyboard:keymap +util/docker_build.sh keyboard:keymap # For example: util/docker_build.sh ergodox_ez:steno ``` -This 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`. +This will compile the desired 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`. 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: ```bash @@ -147,7 +147,7 @@ There is also support for building _and_ flashing the keyboard straight from Doc util/docker_build.sh keyboard:keymap:target # For example: util/docker_build.sh planck/rev6:default:dfu-util ``` -If 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. +If 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](https://github.com/qmk/qmk_toolbox) instead. !> 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**. diff --git a/util/docker_build.sh b/util/docker_build.sh @@ -39,11 +39,12 @@ if [ -n "$target" ]; then else echo "Error: target requires docker-machine to work on your platform" >&2 echo "See http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos" >&2 + echo "Consider flashing with QMK Toolbox (https://github.com/qmk/qmk_toolbox) instead" >&2 exit 3 fi fi dir=$(pwd -W 2>/dev/null) || dir=$PWD # Use Windows path if on Windows # Run container and build firmware -docker run --rm $usb_args -v "$dir":/qmk_firmware qmkfm/qmk_firmware \ +docker run --rm -it $usb_args -v "$dir":/qmk_firmware qmkfm/qmk_firmware \ make "$keyboard${keymap:+:$keymap}${target:+:$target}"