Skip to content

Latest commit

 

History

History
113 lines (75 loc) · 3.28 KB

README.md

File metadata and controls

113 lines (75 loc) · 3.28 KB
Raw

My QMK keymap store ⌨️

QMK setup logo

Installation

Flashing the firmware to your keyboard requires the QMK CLI tool. The following instructions are for macOS.

brew install qmk/qmk/qmk

Alternatively you can use QMK Toolbox, which is a popular GUI flashing tool.

brew install qmk-toolbox

Although not mandatory it is highly recommended to have the GitHub CLI installed to streamline interactions with the CI in case you're going to build via GitHub Actions.

brew install gh

Building and flashing

This repo serves as an External QMK Userspace and as such it can be used to build the QMK firmware in either of two ways.

GitHub Actions

✅ Easier. No setup required.

❌ Longer feedback loop. Changes need to go through CI.

  1. Push your changes to the remote.

    git push origin main

  2. Wait for the CI to pass.

    gh run watch

  3. Grab the firmware from the CI artifacts.

    gh run download

    ℹ️ Please note that these artifacts are ephemeral and they may be expired if you try to access them later on. You can always grab the latest firmware from the Releases page.

  4. Flash the firmware to your keyboard.

    qmk flash keebio_iris_rev7_mikybars.hex

Local

✅ Shorter feedback loop. Errors are caught earlier.

❌ Trickier to set up. Plus you need to download the entire QMK repo.

  1. Set up QMK.

    qmk setup

  2. Clone this repo locally.

    git clone https://github.com/mikybars/qmk_userspace
# or gh repo clone qmk_userspace

  3. Run the following shell command, replacing "path/to/qmk_userspace" with the relative path to your clone of qmk_userspace from the previous step.

    qmk config user.overlay_dir="$(realpath path/to/qmk_userspace)"

  4. (optional) If you only have one keyboard/keymap or you're going to build the same keyboard/keymap frequently, you can set those as default.

    qmk config user.keyboard=keebio/iris/rev7
qmk config user.keymap=mikybars

  5. Build & flash.

    qmk flash                         # use defaults
qmk flash -km mikybars-alt        # build & flash a different keymap
qmk compile -kb keebio/iris/rev8  # build a newer keyboard (compile only)

    ℹ️ Please note that with the previous configuration you don't need to be in any particular directory to run these commands.

  6. (bonus) Add a new keymap.

    cd path/to/qmk_userspace
qmk new-keymap -kb kbdfans/kbd75/rev2 -km mikybars

Acknowledgments ❤️

Thanks to Pascal Getreuer for his contributions to the QMK community, especially for his interesting posts which served me as inspiration to adopt some amazing features such as Caps Word and Layer Lock key.