diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 15:13:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-10 15:13:24 -0400 |
| commit | 06f0f92c1a7b3b362f97cbcad22da6ff6615e6cc (patch) | |
| tree | f0c8ceb58eccf44977ee51f29a8154d2aed188f8 /docs | |
| parent | 792183466329954cfb64fc7093b4079bdc309673 (diff) | |
| download | qmk_firmware-06f0f92c1a7b3b362f97cbcad22da6ff6615e6cc.tar.gz qmk_firmware-06f0f92c1a7b3b362f97cbcad22da6ff6615e6cc.zip | |
Delete VAGRANT_GUIDE.md
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/VAGRANT_GUIDE.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/docs/VAGRANT_GUIDE.md b/docs/VAGRANT_GUIDE.md deleted file mode 100644 index 61cd0815b..000000000 --- a/docs/VAGRANT_GUIDE.md +++ /dev/null | |||
| @@ -1,27 +0,0 @@ | |||
| 1 | # Quick Start Directions | ||
| 2 | |||
| 3 | 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. | ||
| 4 | |||
| 5 | ## Requirements | ||
| 6 | |||
| 7 | 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). | ||
| 8 | |||
| 9 | *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` | ||
| 10 | |||
| 11 | |||
| 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. | ||
| 13 | |||
| 14 | Build Firmware and Program Controller | ||
| 15 | ------------------------------------- | ||
| 16 | See [build_guide.md](build_guide.md), or the readme in the particular keyboards/* folder. | ||
| 17 | |||
| 18 | Change your keymap | ||
| 19 | ------------------ | ||
| 20 | See [keymap.md](keymap.md). | ||
| 21 | |||
| 22 | ## Flashing the firmware | ||
| 23 | |||
| 24 | The "easy" way to flash the firmware is using a tool from your host OS like the Teensy programming app. [ErgoDox EZ](/keyboards/ergodox/readme.md) gives a great example. | ||
| 25 | |||
| 26 | 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. | ||
| 27 | |||