summaryrefslogtreecommitdiff
path: root/docs/getting_started_vagrant.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-04-09 09:26:11 -0700
committerDrashna Jaelre <drashna@live.com>2019-04-09 09:26:11 -0700
commit51a7fb1f1ea74648dc926354c887a04929297aba (patch)
tree653632f08da46b9dc8dc8ab65055927635087f85 /docs/getting_started_vagrant.md
parent7c9d1d58ee9da18fa64cacd564fdf512ec4cb74e (diff)
Remove documentation folder
Diffstat (limited to 'docs/getting_started_vagrant.md')
-rw-r--r--docs/getting_started_vagrant.md21
1 files changed, 0 insertions, 21 deletions
diff --git a/docs/getting_started_vagrant.md b/docs/getting_started_vagrant.md
deleted file mode 100644
index 848a43a1f9..0000000000
--- a/docs/getting_started_vagrant.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Vagrant Quick Start
-
-This project includes a Vagrantfile that will allow you to build a new firmware for your keyboard very easily without major changes to your primary operating system. This also ensures that when you clone the project and perform a build, you have the exact same environment as anyone else using the Vagrantfile to build. This makes it much easier for people to help you troubleshoot any issues you encounter.
-
-## Requirements
-
-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. **Alternately, you can try running the following command:** `vagrant plugin install vagrant-vbguest`
-
-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.
-
-# Flashing the Firmware
-
-The "easy" way to flash the firmware is using a tool from your host OS:
-
-* [QMK Toolbox](https://github.com/qmk/qmk_toolbox) (recommended)
-* [Teensy Loader](https://www.pjrc.com/teensy/loader.html)
-* [Atmel FLIP](http://www.atmel.com/tools/flip.aspx)
-
-If you want to program via the command line you can uncomment the ['modifyvm'] lines in the Vagrantfile to enable the USB passthrough into Linux and then program using the command line tools like dfu-util/dfu-programmer or you can install the Teensy CLI version.