Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 1.95 KB

README.md

File metadata and controls

44 lines (35 loc) · 1.95 KB

QMK Config

This repository includes my personal QMK keymaps to build firmware for keyboards and trackballs:

Family photo

Upper-corners: Ximi - Lower-corners: W-Ergolite - Upper-center: Urchin - Lower-center: Corne

Note

Urchin and Corne are not in this repo, but with my ZMK keyboards.

Userspace

The keymaps are using QMK userspace, most of the configuration is done on the /user directory. So in order to compile, both this repo and a qmk_firmware repo are required.

Build

  1. Run the normal qmk setup procedure if you haven't already done so -- see QMK Docs for details.
  2. Clone my qmk_firmware repository. It contains base configurations for the keyboards, you must build the user space on top of it as the official qmk_firmware doesn't.
  3. Clone this repository
  4. cd into this repository's clone directory
  5. Set global userspace path: qmk config user.overlay_dir="$(realpath .)" -- you MUST be located in the cloned userspace location for this to work correctly
    • This will be automatically detected if you've cded into your userspace repository, but the above makes your userspace available regardless of your shell location.
  6. Compile:
    • qmk compile -kb fingerpunch/ximi/v2 -km jeffdess
    • qmk compile -kb keyclicks/w_ergolite -km jeffdess
    • qmk compile -kb ploopyco/trackball_nano/rev1_001 -km jeffdess

Alternatively, qmk userspace-compile to build all of your userspace targets at once.