mirrors/qmk_userspace
Watch
1
0
Fork
You've already forked qmk_userspace
 1
mirror of https://github.com/qmk/qmk_userspace.git synced 2026-09-07 04:32:08 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add confirmation step for QMK setup in README

Browse source
This commit is contained in:
Chris Keller 2026-08-21 18:22:24 -06:00
commit 36c9fb82b0
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -5,6 +5,7 @@ This is a template repository which allows for an external set of QMK keymaps to
## Howto configure your build targets
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
* Confirm that `qmk --help` lists `new-keymap` and `userspace-add` before continuing. If not, verify `qmk config user.qmk_home` is set to the location of your QMK repository.
1. Fork this repository
1. Clone your fork to your local machine
1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`