X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2FREADME.md;h=065263edbc0e7fa94948ba682a454d6eb0398d5f;hb=fca03e15b9f111e614738d9dcce09e03c49e9409;hp=06597a2b690b99c73d6fe078d4f6c662b4894261;hpb=62214986013ee6596afa55023f7a95a8527d910f;p=qmk_firmware.git diff --git a/docs/README.md b/docs/README.md index 06597a2b6..065263edb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,14 +12,14 @@ Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk ## How to compile {#how-to-compile} -Before you are able to compile, you'll need to [install an environment](build_environment_setup.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: +Before you are able to compile, you'll need to [install an environment](getting_started_build_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: - make planck-rev4-default + make planck/rev4:default -This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects), in which case, it can be omitted: +This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted: - make preonic-default + make preonic:default ## How to customize {#how-to-customize} -QMK has lots of [features](features/README.md) to explore, and a good deal of [reference documentation](reference/README.md) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md). +QMK has lots of [features](features.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).