From 6c22bd66652eaf5a2e0c12d5517c9b8bc807318b Mon Sep 17 00:00:00 2001 From: dragon788 Date: Sat, 16 Jan 2016 20:43:43 -0600 Subject: Create QUICK_START.md describing Vagrantfile usage Provides links to software required to use the Vagrantfile. --- QUICK_START.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 QUICK_START.md (limited to 'QUICK_START.md') diff --git a/QUICK_START.md b/QUICK_START.md new file mode 100644 index 0000000000..f0165bc8ca --- /dev/null +++ b/QUICK_START.md @@ -0,0 +1,21 @@ +# 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). + +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. -- cgit v1.2.3 From b305e622b5c1476142e9547e66705c74a26aabc0 Mon Sep 17 00:00:00 2001 From: dragon788 Date: Sun, 17 Jan 2016 12:39:28 -0600 Subject: Note about Virtualbox incompatibilities --- QUICK_START.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'QUICK_START.md') 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 -- cgit v1.2.3 From 6774167900c93165fe39c80c47c566d6779021f8 Mon Sep 17 00:00:00 2001 From: dragon788 Date: Sun, 17 Jan 2016 17:13:08 -0600 Subject: Command line programming not default, enable by reading quickstart and comments in Vagrantfile --- QUICK_START.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'QUICK_START.md') diff --git a/QUICK_START.md b/QUICK_START.md index 60daba5749..6be377db3c 100644 --- a/QUICK_START.md +++ b/QUICK_START.md @@ -21,3 +21,5 @@ 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. -- cgit v1.2.3