diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-04 00:10:47 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-06-04 00:10:47 -0400 |
| commit | b36e532b5e0eef219f33075e6e60b68d104484ee (patch) | |
| tree | 6979225bc1c87f339b358945ec2558c396da4530 /VAGRANT_GUIDE.md | |
| parent | 189a3b02fb7b43c6bc28271ee0c0bf9eb16810bf (diff) | |
| download | firmware-b36e532b5e0eef219f33075e6e60b68d104484ee.tar.gz firmware-b36e532b5e0eef219f33075e6e60b68d104484ee.tar.bz2 firmware-b36e532b5e0eef219f33075e6e60b68d104484ee.zip | |
cleans up folder structure
* consolidates docs
* deletes converter/
* updates .md references (most)
Diffstat (limited to 'VAGRANT_GUIDE.md')
| -rw-r--r-- | VAGRANT_GUIDE.md | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/VAGRANT_GUIDE.md b/VAGRANT_GUIDE.md deleted file mode 100644 index 922848fd7..000000000 --- a/VAGRANT_GUIDE.md +++ /dev/null @@ -1,26 +0,0 @@ -# Quick Start Directions - -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. - -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 [doc/build.md](tmk_core/doc/build.md), or the README in the particular keyboard/* folder. - -Change your keymap ------------------- -See [doc/keymap.md](tmk_core/doc/keymap.md). - -## Flashing the firmware - -The "easy" way to flash the firmware is using a tool from your host OS like the Teensy programming app. [ErgoDox EZ](keyboard/ergodox_ez/readme.md) gives a great example. - -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. -
\ No newline at end of file |