docs/getting_started_build_tools.md

   1 # Installing Build Tools
   2
   3 This page describes setting up the build environment for QMK. These instructions cover AVR processors (such as the atmega32u4.)
   4
   5 <!-- FIXME: We should have ARM instructions somewhere. -->
   6
   7 ## Linux
   8
   9 To ensure you are always up to date, you can just run `sudo util/install_dependencies.sh`. That should always install all the dependencies needed. **This will run `apt-get upgrade`.**
  10
  11 You can also install things manually, but this documentation might not be always up to date with all requirements.
  12
  13 The current requirements are the following, but not all might be needed depending on what you do. Also note that some systems might not have all the dependencies available as packages, or they might be named differently.
  14
  15 ```
  16 build-essential
  17 gcc
  18 unzip
  19 wget
  20 zip
  21 gcc-avr
  22 binutils-avr
  23 avr-libc
  24 dfu-programmer
  25 dfu-util
  26 gcc-arm-none-eabi
  27 binutils-arm-none-eabi
  28 libnewlib-arm-none-eabi
  29 git
  30 ```
  31
  32 Install the dependencies with your favorite package manager.
  33
  34 Debian/Ubuntu example:
  35
  36     sudo apt-get update
  37     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
  38
  39 ## Nix
  40
  41 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.
  42
  43 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.:
  44
  45     nix-shell --arg arm false
  46
  47 ## Mac
  48 If you're using [homebrew,](http://brew.sh/) you can use the following commands:
  49
  50     brew tap osx-cross/avr
  51     brew tap PX4/homebrew-px4
  52     brew update
  53     brew install avr-gcc
  54     brew install dfu-programmer
  55     brew install gcc-arm-none-eabi
  56
  57 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.
  58
  59 ## Windows with msys2 (recommended)
  60
  61 The best environment to use, for Windows Vista through any later version (tested on 7 and 10,) is [msys2](http://www.msys2.org).
  62
  63 * Install msys2 by downloading and following the instructions here: http://www.msys2.org
  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:
  66  * `$ cd /c/qmk_firmware`
  67 * Run `util/msys2_install.sh` and follow the prompts
  68
  69 ## Windows 10 (deprecated)
  70 These are the old instructions for Windows 10. We recommend you use [MSYS2 as outlined above](#windows-with-msys2-recommended).
  71
  72 ### Creators Update
  73 If you have Windows 10 with Creators Update or later, you can build and flash the firmware directly. Before the Creators Update, only building was possible. If you don't have it yet or if are unsure, follow [these instructions](https://support.microsoft.com/en-us/instantanswers/d4efb316-79f0-1aa1-9ef3-dcada78f3fa0/get-the-windows-10-creators-update).
  74
  75 ### Windows Subsystem for Linux
  76 In addition to the Creators Update, you need Windows 10 Subystem for Linux, so install it following [these instructions](http://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/). If you already have the Windows 10 Subsystem for Linux from the Anniversary update it's recommended that you [upgrade](https://betanews.com/2017/04/14/upgrade-windows-subsystem-for-linux/) it to 16.04LTS, because some keyboards don't compile with the toolchains included in 14.04LTS. Note that you need to know what your are doing if you chose the `sudo do-release-upgrade` method.
  77
  78 ### Git
  79 If you already have cloned the repository on your Windows file system you can ignore this section.
  80
  81 You 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
  83 Once 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
  85 ### Toolchain setup
  86 The 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.
  87
  88 1. Open "Bash On Ubuntu On Windows" from the start menu.
  89 2. Go to the directory where you cloned `qmk_firmware`. Note that the paths start with `/mnt/` in the WSL, so you have to write for example `cd /mnt/c/path/to/qmk_firmware`.
  90 3. Run `util/wsl_install.sh` and follow the on-screen instructions.
  91 4. Close the Bash command window, and re-open it.
  92 5. You are ready to compile and flash the firmware!
  93
  94 ### Some important things to keep in mind
  95 * You can run `util/wsl_install.sh` again to get all the newest updates.
  96 * Your QMK repository need to be on a Windows file system path, since WSL can't run executables outside it.
  97 * The WSL Git is **not** compatible with the Windows Git, so use the Windows Git Bash or a windows Git GUI for all Git operations
  98 * You can edit files either inside WSL or normally using Windows, but note that if you edit makefiles or shell scripts, make sure you are using an editor that saves the files with Unix line endings. Otherwise the compilation might not work.
  99
 100 ## Windows (Vista and later) (Deprecated)
 101
 102 These are the old instructions for Windows Vista and later. We recommend you use [MSYS2 as outlined above](#windows-with-msys2-recommended).
 103
 104 1. If you have ever installed WinAVR, uninstall it.
 105 2. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**.
 106 3. If you are going to flash Infinity based keyboards you will need to install dfu-util, refer to the instructions by [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware).
 107 4. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location.
 108 5. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/qmk/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer.
 109 6. Open the `\util` folder.
 110 7. Double-click on the `1-setup-path-win` batch script to run it. You'll need to accept a User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up.
 111 8. Right-click on the `2-setup-environment-win` batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete!
 112
 113 If you have trouble and want to ask for help, it is useful to generate a *Win_Check_Output.txt* file by running `Win_Check.bat` in the `\util` folder.
 114
 115 ## Docker
 116
 117 If 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:
 118
 119 ```bash
 120 # You'll run this every time you want to build a keymap
 121 # modify the keymap and keyboard assigment to compile what you want
 122 # defaults are ergodox/default
 123
 124 docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
 125
 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
 127 docker run -e keymap=default -e keyboard=ergobox_ez --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware
 128
 129 ```
 130
 131 This will compile the targeted keyboard/keymap and leave it in your QMK directory for you to flash.
 132
 133 ## Vagrant
 134 If 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).