From 0ded95b88882ba7bdc1890f7462f0af96b10fadb Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 12:28:48 -0700 Subject: Update the vagrant guide --- docs/vagrant_guide.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) (limited to 'docs/vagrant_guide.md') diff --git a/docs/vagrant_guide.md b/docs/vagrant_guide.md index 61cd0815b..e6551cb25 100644 --- a/docs/vagrant_guide.md +++ b/docs/vagrant_guide.md @@ -1,4 +1,4 @@ -# Quick Start Directions +# 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. @@ -8,20 +8,14 @@ Using the `/Vagrantfile` in this repository requires you have [Vagrant](http://w *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. -Build Firmware and Program Controller -------------------------------------- -See [build_guide.md](build_guide.md), or the readme in the particular keyboards/* folder. - -Change your keymap ------------------- -See [keymap.md](keymap.md). +# Flashing the firmware -## Flashing the firmware +The "easy" way to flash the firmware is using a tool from your host OS: -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. +* [QMK Flasher](https://github.com/qmk/qmk_flasher) +* [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. - -- cgit v1.2.3-70-g09d2