From 30b0184dcea5492be94559e4c24efb5cc16b4b42 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Fri, 4 Jun 2021 19:44:04 -0700 Subject: [PATCH] Update Readme with proper QMK-CLI instructions --- readme.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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