qmk_firmware/BUILD_GUIDE.md

26 lines
1,023 B
Markdown
Raw Normal View History

2016-03-03 03:03:25 +00:00
# Build Guide
## Build Environment Setup
2016-03-03 03:03:25 +00:00
### Windows
What these instructions look like depends on whether NoahAndrews's setup scripts get merged
2016-03-03 03:03:25 +00:00
### Mac
2016-03-03 03:38:22 +00:00
If you're using [homebrew,](http://brew.sh/) you can use the following commands:
2016-03-03 03:03:25 +00:00
brew tap osx-cross/avr
brew install avr-libc
brew install dfu-programmer
2016-03-03 03:38:22 +00:00
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.
You can also try these instructions:
1. Install Xcode from the App Store.
2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
3. Install [DFU-Programmer][dfu-prog].
2016-03-03 03:03:25 +00:00
### Linux
### Vagrant
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).