BUILD_GUIDE.md

   1 # Build Guide
   2
   3 ## Build Environment Setup
   4
   5 ### Windows
   6 What these instructions look like depends on whether NoahAndrews's setup scripts get merged
   7
   8 ### Mac
   9 If you're using homebrew, you can use the following commands:
  10
  11     brew tap osx-cross/avr
  12     brew install avr-libc
  13     brew install dfu-programmer
  14
  15 Otherwise, these instructions will work:
  16
  17 1. Install Xcode from the App Store.
  18 2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
  19 3. Install [DFU-Programmer][dfu-prog].
  20
  21 ### Linux
  22
  23 ### Vagrant
  24 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 file](VAGRANT_GUIDE.md).