summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordragon788 <dragon788@users.noreply.github.com>2016-01-16 20:46:15 -0600
committerdragon788 <dragon788@users.noreply.github.com>2016-01-16 20:46:15 -0600
commitebd209d285ffdad5d56098c8d4edb6f2f364c907 (patch)
treebf2c920f1b220964e77823878f2dff5e73295c66 /README.md
parent6c22bd66652eaf5a2e0c12d5517c9b8bc807318b (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 55fb76798b..33005227df 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ 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.
* 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.