summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2015-03-18 15:19:40 +0100
committerJack Humbert <jack.humb@gmail.com>2015-03-18 15:19:40 +0100
commit9c3a95663410a294f2c85ad2d1c016f328730e0b (patch)
treef0d4e1bdacab862e9fa270c73b5ddf4ba8cb44ce
parent9307a0a3e415d33d0858283f67fcba4c59a042ff (diff)
downloadqmk_firmware-9c3a95663410a294f2c85ad2d1c016f328730e0b.tar.gz
qmk_firmware-9c3a95663410a294f2c85ad2d1c016f328730e0b.tar.xz
Update README.md
-rw-r--r--keyboard/planck/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index cb009c005..206d6ad80 100644
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -9,6 +9,11 @@ DIY/Assembled compact ortholinear keyboard by [Ortholinear Keyboards](http://ort
- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
## Build
+
+Follow [this guide](http://deskthority.net/workshop-f7/how-to-build-your-very-own-keyboard-firmware-t7177.html) to setup your development environment before anything else.
+
+Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/archive/master.zip) and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type "make" to generate your .hex that you can load with the Teensy app onto your Planck (once you've hit reset/shorted GND & RST).
+
Move to this directory then just run `make` like:
$ make