summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-06-04 19:44:04 -0700
committerGitHub <noreply@github.com>2021-06-04 19:44:04 -0700
commit30b0184dcea5492be94559e4c24efb5cc16b4b42 (patch)
treedbc49af4ff4397c91f6c7b77c148078753411589
parentc85ce3b58c0626d8741619d46351f241209a0ff1 (diff)
Update Readme with proper QMK-CLI instructions
-rw-r--r--readme.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 9d6cc1a0cc..b9639565e4 100644
--- a/readme.md
+++ b/readme.md
@@ -15,7 +15,12 @@ This purpose of this fork is maintain a clean repo that only contains the keyboa
## Building
-To build, don't check out `master`, but check out the latest firmware branch (`firmware20`, for example).
+To set up the local build enviroment to create the firmware image manually, head to the [Newbs guide from QMK](https://docs.qmk.fm/#/newbs).
+And instead of using just `qmk setup`, you will want to run this instead:
+
+```sh
+qmk setup zsa/qmk_firmware -b firmware20
+```
## Maintainers