summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-03-04 10:19:28 -0500
committerJack Humbert <jack.humb@gmail.com>2016-03-04 10:19:28 -0500
commit5f3e99f67b2d8ae4d04fa132c154e1c3aed68e7b (patch)
tree73e351bda73a9e0e45a33a3717bc2508196ff0b7
parent3f7180a73ec3d4f75d39f7122078c9b892032885 (diff)
parentb9c22ff8fc0e27b1bcc4f62785289ca2c7e695d9 (diff)
Merge pull request #171 from NoahAndrews/restructure-documentation
Restructure documentation
-rw-r--r--BUILD_GUIDE.md26
-rw-r--r--HAND_WIRE.md (renamed from HAND-WIRE.md)0
-rw-r--r--README.md5
-rw-r--r--VAGRANT_GUIDE.md (renamed from QUICK_START.md)1
4 files changed, 30 insertions, 2 deletions
diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md
new file mode 100644
index 0000000000..783d00e8d1
--- /dev/null
+++ b/BUILD_GUIDE.md
@@ -0,0 +1,26 @@
+# Build Guide
+
+## Build Environment Setup
+
+### Windows
+What these instructions look like depends on whether NoahAndrews's setup scripts get merged
+
+### Mac
+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
+
+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`.
+3. Install [DFU-Programmer][dfu-prog].
+
+### 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
diff --git a/HAND-WIRE.md b/HAND_WIRE.md
index 3f4d75b272..3f4d75b272 100644
--- a/HAND-WIRE.md
+++ b/HAND_WIRE.md
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 <project_name>`, which will create `/keyboard/<project_name>` 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
diff --git a/QUICK_START.md b/VAGRANT_GUIDE.md
index 948308ca11..922848fd75 100644
--- a/QUICK_START.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