X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Fgetting_started_build_tools.md;h=934617d852241fdcdb8162b8c553adf0e79e5a8f;hb=91683d56fa5c9cf9893219b3dac269e20a2c7251;hp=e46b7f2e537058183ac5725fdf0bc61a7075bb27;hpb=9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a;p=qmk_firmware.git diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md index e46b7f2e5..934617d85 100644 --- a/docs/getting_started_build_tools.md +++ b/docs/getting_started_build_tools.md @@ -36,12 +36,23 @@ Debian/Ubuntu example: sudo apt-get update sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi -# Mac +## Nix + +If you're on [NixOS](https://nixos.org/), or have Nix installed on Linux or macOS, run `nix-shell` from the repository root to get a build environment. + +By default, this will download compilers for both AVR and ARM. If you don't need both, disable the `avr` or `arm` arguments, e.g.: + + nix-shell --arg arm false + +## Mac If you're using [homebrew,](http://brew.sh/) you can use the following commands: brew tap osx-cross/avr - brew install avr-libc + brew tap PX4/homebrew-px4 + brew update + brew install avr-gcc brew install dfu-programmer + brew install gcc-arm-none-eabi This is the recommended method. If you don't have homebrew, [install it!](http://brew.sh/) It's very much worth it for anyone who works in the command line. Note that the `make` and `make install` portion during the homebrew installation of avr-libc can take over 20 minutes and exhibit high CPU usage. @@ -110,10 +121,10 @@ If this is a bit complex for you, Docker might be the turn-key solution you need # modify the keymap and keyboard assigment to compile what you want # defaults are ergodox/default -docker run -e keymap=gwen -e subproject=ez -e keyboard=ergodox --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware +docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware # On windows docker seems to have issue with VOLUME tag in Dockerfile, and $('pwd') won't print a windows compliant path, use full path instead like this -docker run -e keymap=default -e subproject=ez -e keyboard=ergobox --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware +docker run -e keymap=default -e keyboard=ergobox_ez --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware ```