summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorErez Zukerman <bulk@ezuk.org>2016-01-18 19:38:32 -0500
committerErez Zukerman <bulk@ezuk.org>2016-01-18 19:38:32 -0500
commit393f26f250f704933882d93312d19685ec55801f (patch)
tree7b8ca5e59d8d13d06ee5f6e164e48ee1cb4f05c1 /README.md
parent0c3aed93db9f07535a72b4c8d96e7aee5f23b085 (diff)
parent6774167900c93165fe39c80c47c566d6779021f8 (diff)
Merge pull request #73 from dragon788/dragon_mod
Requesting some comments and review on my changes
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 f46bd68e26..2ed05e76e2 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.