diff options
| author | Noah Andrews <NoahAndrews@users.noreply.github.com> | 2016-03-29 20:03:22 -0400 |
|---|---|---|
| committer | Noah Andrews <NoahAndrews@users.noreply.github.com> | 2016-03-29 20:03:22 -0400 |
| commit | e28334017c94c6928dd7e82436cec171f0243747 (patch) | |
| tree | d2b2ecb96aff656094b2113f83632e3131000a75 /README.md | |
| parent | ccf848917b7e931327f6c4a469877e9d8ef238ea (diff) | |
| parent | 26513b497b8bae5160389c0beac2d45cbb29c50f (diff) | |
| download | firmware-e28334017c94c6928dd7e82436cec171f0243747.tar.gz firmware-e28334017c94c6928dd7e82436cec171f0243747.tar.bz2 firmware-e28334017c94c6928dd7e82436cec171f0243747.zip | |
Merge remote-tracking branch 'jackhumbert/master' into make-keymap-names-consistent
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -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 |