X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2FREADME.md;h=065263edbc0e7fa94948ba682a454d6eb0398d5f;hb=fd1a0d675376ccc967cfab3a8ce16ce65a7505a6;hp=09317d652037d89b6525f287ae0a93c06a8fcc13;hpb=9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a;p=qmk_firmware.git diff --git a/docs/README.md b/docs/README.md index 09317d652..065263edb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,13 +12,13 @@ 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}