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.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/getting_started_build_tools.md b/docs/getting_started_build_tools.md
index 934617d85..88612ff56 100644
--- a/docs/getting_started_build_tools.md
+++ b/docs/getting_started_build_tools.md
@@ -1,6 +1,6 @@
1# Installing Build Tools 1# Installing Build Tools
2 2
3This page describes setting up the build environment for QMK. These instructions cover AVR processors (such as the atmega32u4.) 3This page describes setting up the build environment for QMK. These instructions cover AVR processors (such as the atmega32u4).
4 4
5<!-- FIXME: We should have ARM instructions somewhere. --> 5<!-- FIXME: We should have ARM instructions somewhere. -->
6 6
@@ -44,7 +44,7 @@ By default, this will download compilers for both AVR and ARM. If you don't need
44 44
45 nix-shell --arg arm false 45 nix-shell --arg arm false
46 46
47## Mac 47## macOS
48If you're using [homebrew,](http://brew.sh/) you can use the following commands: 48If you're using [homebrew,](http://brew.sh/) you can use the following commands:
49 49
50 brew tap osx-cross/avr 50 brew tap osx-cross/avr
@@ -58,10 +58,10 @@ This is the recommended method. If you don't have homebrew, [install it!](http:/
58 58
59## Windows with msys2 (recommended) 59## Windows with msys2 (recommended)
60 60
61The best environment to use, for Windows Vista through any later version (tested on 7 and 10,) is [msys2](http://www.msys2.org). 61The best environment to use, for Windows Vista through any later version (tested on 7 and 10), is [msys2](http://www.msys2.org).
62 62
63* Install msys2 by downloading and following the instructions here: http://www.msys2.org 63* Install msys2 by downloading it and following the instructions here: http://www.msys2.org
64* Open the "MSYS2 MingGW 64-bit" shortcut 64* Open the ``MSYS2 MingGW 64-bit`` shortcut
65* Navigate to your qmk checkout. For example, if it's in the root of your c drive: 65* Navigate to your qmk checkout. For example, if it's in the root of your c drive:
66 * `$ cd /c/qmk_firmware` 66 * `$ cd /c/qmk_firmware`
67* Run `util/msys2_install.sh` and follow the prompts 67* Run `util/msys2_install.sh` and follow the prompts
@@ -80,7 +80,7 @@ If you already have cloned the repository on your Windows file system you can ig
80 80
81You will need to clone the repository to your Windows file system using the normal Git for Windows and **not** the WSL Git. So if you haven't installed Git before, [download](https://git-scm.com/download/win) and install it. Then [set it up](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), it's important that you setup the e-mail and user name, especially if you are planning to contribute. 81You will need to clone the repository to your Windows file system using the normal Git for Windows and **not** the WSL Git. So if you haven't installed Git before, [download](https://git-scm.com/download/win) and install it. Then [set it up](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup), it's important that you setup the e-mail and user name, especially if you are planning to contribute.
82 82
83Once Git is installed, open the Git bash command and change the directory to where you want to clone QMK, note that you have to use forward slashes, and that your c drive is accessed like this `/c/path/to/where/you/want/to/go`. Then run `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`, this will create a new folder `qmk_firmware` as a subfolder of the current one. 83Once Git is installed, open the Git Bash command and change the directory to where you want to clone QMK; note that you have to use forward slashes, and that your c drive is accessed like this `/c/path/to/where/you/want/to/go`. Then run `git clone --recurse-submodules https://github.com/qmk/qmk_firmware`, this will create a new folder `qmk_firmware` as a subfolder of the current one.
84 84
85### Toolchain setup 85### Toolchain setup
86The Toolchain setup is done through the Windows Subsystem for Linux, and the process is fully automated. If you want to do everything manually, there are no other instructions than the scripts themselves, but you can always open issues and ask for more information. 86The Toolchain setup is done through the Windows Subsystem for Linux, and the process is fully automated. If you want to do everything manually, there are no other instructions than the scripts themselves, but you can always open issues and ask for more information.
@@ -122,8 +122,11 @@ If this is a bit complex for you, Docker might be the turn-key solution you need
122# defaults are ergodox/default 122# defaults are ergodox/default
123 123
124docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware 124docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
125```
126
127On 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:
125 128
126# 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 129```bash
127docker run -e keymap=default -e keyboard=ergobox_ez --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware 130docker run -e keymap=default -e keyboard=ergobox_ez --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware
128 131
129``` 132```
@@ -131,4 +134,4 @@ docker run -e keymap=default -e keyboard=ergobox_ez --rm -v D:/Users/Sacapuces/D
131This will compile the targeted keyboard/keymap and leave it in your QMK directory for you to flash. 134This will compile the targeted keyboard/keymap and leave it in your QMK directory for you to flash.
132 135
133## Vagrant 136## Vagrant
134If 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](vagrant_guide.md). 137If 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).