- Run the normal
qmk setup
procedure if you haven't already done so -- see QMK Docs for details. - Fork this repository
- Clone your fork to your local machine
cd
into this repository's clone directory- Set global userspace path:
qmk config user.overlay_dir="$(realpath .)"
-- you MUST be located in the cloned userspace location for this to work correctly - Compile normally:
qmk compile -kb your_keyboard -km your_keymap
- Add your keymap(s) to the build by running
qmk userspace-add -kb lily58 -km lva
- This will automatically update your
qmk.json
file - Corresponding
qmk userspace-remove -kb lily58 -km lva
will delete it - Listing the build targets can be done with with
qmk userspace-list
- This will automatically update your
- Compile
qmk compile -kb lily58 -km lva
- Flash
qmk compile -kb lily58 -km lva