summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordragon788 <dragon788@users.noreply.github.com>2016-01-17 12:39:28 -0600
committerdragon788 <dragon788@users.noreply.github.com>2016-01-17 12:39:28 -0600
commitb305e622b5c1476142e9547e66705c74a26aabc0 (patch)
treef0690e9f9406f3f952e0d40bda62ab342e6abfb2
parentebd209d285ffdad5d56098c8d4edb6f2f364c907 (diff)
downloadqmk_firmware-b305e622b5c1476142e9547e66705c74a26aabc0.tar.gz
qmk_firmware-b305e622b5c1476142e9547e66705c74a26aabc0.zip
Note about Virtualbox incompatibilities
-rw-r--r--QUICK_START.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/QUICK_START.md b/QUICK_START.md
index f0165bc8ca..60daba5749 100644
--- a/QUICK_START.md
+++ b/QUICK_START.md
@@ -6,6 +6,8 @@ This project includes a Vagrantfile that will allow you to build a new firmware
Using the Vagrantfile in this repository requires you have [Vagrant](http://www.vagrantup.com/) as well as [VirtualBox](https://www.virtualbox.org/) (or [VMware Workstation](https://www.vmware.com/products/workstation) and [Vagrant VMware plugin](http://www.vagrantup.com/vmware) but the (paid) VMware plugin requires a licensed copy of VMware Workstation/Fusion).
+*COMPATIBILITY NOTICE* Certain versions of Virtualbox 5 appear to have an incompatibility with the Virtualbox extensions installed in the boxes in this Vagrantfile. If you encounter any issues with the /vagrant mount not succeeding, please upgrade your version of Virtualbox to at least 5.0.12.
+
Other than having Vagrant and Virtualbox installed and possibly a restart of your computer afterwards, you can simple run a 'vagrant up' anywhere inside the folder where you checked out this project and it will start a Linux virtual machine that contains all the tools required to build this project. There is a post Vagrant startup hint that will get you off on the right foot, otherwise you can also reference the build documentation below.
Build Firmware and Program Controller