From d47cac9bb3027a453c702a0dbb575de6e8668a37 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 21:27:45 -0500 Subject: [PATCH 1/8] Renamed QUICK_START.md to VAGRANT_GUIDE.md --- QUICK_START.md => VAGRANT_GUIDE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename QUICK_START.md => VAGRANT_GUIDE.md (100%) diff --git a/QUICK_START.md b/VAGRANT_GUIDE.md similarity index 100% rename from QUICK_START.md rename to VAGRANT_GUIDE.md From a399823b936e6b0eabd144c5a513dedf5f8450d2 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 21:53:55 -0500 Subject: [PATCH 2/8] Added stub BUILD_GUIDE.md --- BUILD_GUIDE.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 BUILD_GUIDE.md diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md new file mode 100644 index 0000000000..2a1eaa555d --- /dev/null +++ b/BUILD_GUIDE.md @@ -0,0 +1 @@ +# Build Guide \ No newline at end of file From 3871ced15c880cb6d4975e1f1c4fb009f0b37adf Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:03:25 -0500 Subject: [PATCH 3/8] Added Vagrant explanation --- BUILD_GUIDE.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 2a1eaa555d..272df46c81 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -1 +1,14 @@ -# Build Guide \ No newline at end of file +# Build Guide + +## Platform-specific setup + +### Windows + + +### Mac + + +### Linux + +### Vagrant +If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md). \ No newline at end of file From 92c3397ffc9cff22dee5a893023050492d31c4e3 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:07:26 -0500 Subject: [PATCH 4/8] Added placeholder for windows section of build guide --- BUILD_GUIDE.md | 4 ++-- VAGRANT_GUIDE.md | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 272df46c81..d7106d9183 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -1,9 +1,9 @@ # Build Guide -## Platform-specific setup +## Build Environment Setup ### Windows - +What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac diff --git a/VAGRANT_GUIDE.md b/VAGRANT_GUIDE.md index 948308ca11..922848fd75 100644 --- a/VAGRANT_GUIDE.md +++ b/VAGRANT_GUIDE.md @@ -23,3 +23,4 @@ See [doc/keymap.md](tmk_core/doc/keymap.md). 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 From 04b47cb2eb862451d2b98243d0560abbe4b47699 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:10:10 -0500 Subject: [PATCH 5/8] Renamed handwriting guide to fit repository convention --- HAND-WIRE.md => HAND_WIRE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename HAND-WIRE.md => HAND_WIRE.md (100%) diff --git a/HAND-WIRE.md b/HAND_WIRE.md similarity index 100% rename from HAND-WIRE.md rename to HAND_WIRE.md From 0eb252eb61b1ec21131f8b3bd4048ff5c434f921 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:16:43 -0500 Subject: [PATCH 6/8] Added Mac section (copy/pasted from PCB_GUIDE.md) --- BUILD_GUIDE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index d7106d9183..07ed0e98d7 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -6,7 +6,17 @@ What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac +If you're using homebrew, you can use the following commands: + brew tap osx-cross/avr + brew install avr-libc + brew install dfu-programmer + +Otherwise, these instructions will work: + +1. Install Xcode from the App Store. +2. Install the Command Line Tools from `Xcode->Preferences->Downloads`. +3. Install [DFU-Programmer][dfu-prog]. ### Linux From 492e88b24b5c95b028e5e1d97873558280f14ada Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:33:38 -0500 Subject: [PATCH 7/8] Updated README to point to new build guide --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6cb73f1804..6a6bbed40b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ The documentation below explains QMK customizations and elaborates on some of th ## Getting started -* **If you're looking to customize a keyboard that currently runs QMK or TMK** , find your keyboard's directory under `/keyboard/` and read the README file. This will get you all set up. -* Read the [QUICK_START.md](QUICK_START.md) if you want to hit the ground running with minimal fuss or you aren't a technical person and you just want to build the firmware with the least amount of hassle possible. +* [BUILD_GUIDE.md](BUILD_GUIDE.md) contains instructions to set up a build environment, build the firmware, and deploy it to a keyboard. Once your build environment has been set up, all `make` commands to actually build the firmware must be run from a folder in `keyboard/`. +* If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboard/` and run the make commands from there. * If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh `, which will create `/keyboard/` with all the necessary components for a Quantum project. You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you. @@ -309,3 +309,4 @@ what things are (and likely aren't) too risky. - EEPROM has around a 100000 write cycle. You shouldn't rewrite the firmware repeatedly and continually; that'll burn the EEPROM eventually. + \ No newline at end of file From b9c22ff8fc0e27b1bcc4f62785289ca2c7e695d9 Mon Sep 17 00:00:00 2001 From: Noah Andrews Date: Wed, 2 Mar 2016 22:38:22 -0500 Subject: [PATCH 8/8] Clarified recommended Mac setup method --- BUILD_GUIDE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 07ed0e98d7..783d00e8d1 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -6,13 +6,15 @@ What these instructions look like depends on whether NoahAndrews's setup scripts get merged ### Mac -If you're using homebrew, you can use the following commands: +If you're using [homebrew,](http://brew.sh/) you can use the following commands: brew tap osx-cross/avr brew install avr-libc brew install dfu-programmer -Otherwise, these instructions will work: +This is the recommended method. If you don't have homebrew, [install it!](http://brew.sh/) It's very much worth it for anyone who works in the command line. + +You can also try these instructions: 1. Install Xcode from the App Store. 2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.