QMK Userspace

Custom keymaps maintained separately from the main QMK repository using the QMK Userspace template. Firmware is built automatically with GitHub Actions on push.

Keyboards

Keyboard	Keymap
Corne (crkbd rev1)	perrwa
Boardsource Lulu (AVR)	perrwa
TKC Portico	lilycat

Keymap Visualizations

Generated by keymap-drawer — SVGs are auto-updated via CI when YAML sources change. See keymap-drawer/ for per-board SVGs.

Building with GitHub Actions

1. In the GitHub Actions tab, enable workflows
2. Push your changes to your forked GitHub repository
3. Wait for the actions run to complete
4. If you pushed to main, grab the latest firmware from the Releases tab
5. If you pushed to any other branch, download the build artifacts from that workflow run instead

Building locally

1. Run the normal qmk setup procedure if you haven't already done so — see QMK Docs for details.
2. Clone this repository
3. Set the userspace overlay: qmk config user.overlay_dir="$(realpath .)" (run from the repo root)
4. Compile a single target: qmk compile -kb <keyboard> -km <keymap>
5. Or build everything at once: qmk userspace-compile

Managing build targets

Add or remove keymaps from qmk.json:

qmk userspace-add -kb <keyboard> -km <keymap>
qmk userspace-remove -kb <keyboard> -km <keymap>
qmk userspace-list

Customizing the GitHub Actions build

To point the build at a different QMK repository or branch, edit .github/workflows/build.yml and .github/workflows/release.yml:

    with:
      qmk_repo: qmk/qmk_firmware
      qmk_ref: master

Alternatively, add qmk_firmware as a git submodule and Actions will use the pinned revision automatically.