From a399823b936e6b0eabd144c5a513dedf5f8450d2 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 21:53:55 -0500 Subject: Added stub BUILD_GUIDE.md --- BUILD_GUIDE.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 BUILD_GUIDE.md (limited to 'BUILD_GUIDE.md') diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md new file mode 100644 index 0000000000..2a1eaa555d --- /dev/null +++ b/BUILD_GUIDE.md @@ -0,0 +1 @@ +# Build Guide \ No newline at end of file -- cgit v1.2.3 From 3871ced15c880cb6d4975e1f1c4fb009f0b37adf Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:03:25 -0500 Subject: Added Vagrant explanation --- BUILD_GUIDE.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'BUILD_GUIDE.md') diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 2a1eaa555d..272df46c81 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -1 +1,14 @@ -# Build Guide \ No newline at end of file +# Build Guide + +## Platform-specific setup + +### Windows + + +### Mac + + +### 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 -- cgit v1.2.3 From 92c3397ffc9cff22dee5a893023050492d31c4e3 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:07:26 -0500 Subject: Added placeholder for windows section of build guide --- BUILD_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'BUILD_GUIDE.md') diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 272df46c81..d7106d9183 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -1,9 +1,9 @@ # Build Guide -## Platform-specific setup +## Build Environment Setup ### Windows - +What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac -- cgit v1.2.3 From 0eb252eb61b1ec21131f8b3bd4048ff5c434f921 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:16:43 -0500 Subject: Added Mac section (copy/pasted from PCB_GUIDE.md) --- BUILD_GUIDE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'BUILD_GUIDE.md') diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index d7106d9183..07ed0e98d7 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -6,7 +6,17 @@ What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac +If you're using homebrew, you can use the following commands: + brew tap osx-cross/avr + brew install avr-libc + brew install dfu-programmer + +Otherwise, these instructions will work: + +1. Install Xcode from the App Store. +2. Install the Command Line Tools from `Xcode->Preferences->Downloads`. +3. Install [DFU-Programmer][dfu-prog]. ### Linux -- cgit v1.2.3 From b9c22ff8fc0e27b1bcc4f62785289ca2c7e695d9 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:38:22 -0500 Subject: Clarified recommended Mac setup method --- BUILD_GUIDE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'BUILD_GUIDE.md') diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 07ed0e98d7..783d00e8d1 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -6,13 +6,15 @@ What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac -If you're using homebrew, you can use the following commands: +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 -Otherwise, these instructions will work: +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`. -- cgit v1.2.3