aboutsummaryrefslogtreecommitdiffstats
path: root/BUILD_GUIDE.md
diff options
context:
space:
mode:
authorGravatar Noah Andrews <NoahAndrews@users.noreply.github.com>2016-03-02 22:03:25 -0500
committerGravatar Noah Andrews <NoahAndrews@users.noreply.github.com>2016-03-02 22:03:25 -0500
commit3871ced15c880cb6d4975e1f1c4fb009f0b37adf (patch)
treebeadad455097908264b7b23f103f9881525cff07 /BUILD_GUIDE.md
parenta399823b936e6b0eabd144c5a513dedf5f8450d2 (diff)
downloadqmk_firmware-3871ced15c880cb6d4975e1f1c4fb009f0b37adf.tar.gz
Added Vagrant explanation
Diffstat (limited to 'BUILD_GUIDE.md')
-rw-r--r--BUILD_GUIDE.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md
index 2a1eaa555..272df46c8 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