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.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md
index 2721a9a03..fea20e59b 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -43,7 +43,7 @@ Debian / Ubuntu example:
43Fedora / Red Hat example: 43Fedora / Red Hat example:
44 44
45 sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs arm-none-eabi-binutils-cs arm-none-eabi-newlib 45 sudo dnf install gcc unzip wget zip dfu-util dfu-programmer avr-gcc avr-libc binutils-avr32-linux-gnu arm-none-eabi-gcc-cs arm-none-eabi-binutils-cs arm-none-eabi-newlib
46 46
47Arch / Manjaro example: 47Arch / Manjaro example:
48 48
49 pacman -S base-devel gcc unzip wget zip avr-gcc avr-binutils avr-libc dfu-util arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib git dfu-programmer dfu-util 49 pacman -S base-devel gcc unzip wget zip avr-gcc avr-binutils avr-libc dfu-util arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib git dfu-programmer dfu-util
@@ -57,16 +57,17 @@ By default, this will download compilers for both AVR and ARM. If you don't need
57 nix-shell --arg arm false 57 nix-shell --arg arm false
58 58
59## macOS 59## macOS
60If you're using [homebrew,](http://brew.sh/) you can use the following commands: 60If you're using [Homebrew](http://brew.sh/), you can use the following commands:
61 61
62 brew tap osx-cross/avr 62 brew tap osx-cross/avr
63 brew tap PX4/homebrew-px4 63 brew tap osx-cross/arm
64 brew update 64 brew update
65 brew install avr-gcc@8 65 brew install avr-gcc@8
66 brew link --force avr-gcc@8 66 brew link --force avr-gcc@8
67 brew install dfu-programmer 67 brew install dfu-programmer
68 brew install dfu-util 68 brew install dfu-util
69 brew install gcc-arm-none-eabi 69 brew install arm-gcc-bin@8
70 brew link --force arm-gcc-bin@8
70 brew install avrdude 71 brew install avrdude
71 72
72This 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-gcc@8` can take over 20 minutes and exhibit high CPU usage. 73This 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-gcc@8` can take over 20 minutes and exhibit high CPU usage.
@@ -119,12 +120,12 @@ If this is a bit complex for you, Docker might be the turnkey solution you need.
119util/docker_build.sh keyboard:keymap 120util/docker_build.sh keyboard:keymap
120# For example: util/docker_build.sh ergodox_ez:steno 121# For example: util/docker_build.sh ergodox_ez:steno
121``` 122```
122This 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`. 123This 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, all keymaps are used. Note that the parameter format is the same as when building with `make`.
123 124
124You 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: 125You 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:
125```bash 126```bash
126util/docker_build.sh 127util/docker_build.sh
127# Reads parameters as input (leave blank for defaults) 128# Reads parameters as input (leave blank for all keyboards/keymaps)
128``` 129```
129 130
130There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: 131There is also support for building _and_ flashing the keyboard straight from Docker by specifying the `target` as well: