summaryrefslogtreecommitdiff
path: root/BUILD_GUIDE.md
diff options
context:
space:
mode:
Diffstat (limited to 'BUILD_GUIDE.md')
-rw-r--r--BUILD_GUIDE.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md
new file mode 100644
index 000000000..783d00e8d
--- /dev/null
+++ b/BUILD_GUIDE.md
@@ -0,0 +1,26 @@
+# Build Guide
+
+## Build Environment Setup
+
+### Windows
+What these instructions look like depends on whether NoahAndrews's setup scripts get merged
+
+### Mac
+If you're using [homebrew,](http://brew.sh/) you can use the following commands:
+
+ brew tap osx-cross/avr
+ brew install avr-libc
+ brew install dfu-programmer
+
+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].
+
+### 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). \ No newline at end of file