qmk-keymaps

A repository containing my keymaps for QMK keyboards.

It contains QMK Firmware as a submodule.
The compilation script works by symlinking a keymap into the submodule.

Folder structure

The folder structure is <keyboard>/<keymap>:

crkbd
└── limi7break
    ├── config.h
    ├── keymap.c
    ├── rgb_matrix_user.inc
    └── rules.mk

Prerequisites

  • Install the QMK CLI and setup QMK:

    python3 -m pip install --user qmk
    qmk setup

Usage

  • Clone the repository:

    git clone https://github.com/limi7break/qmk-keymaps.git
    cd qmk-keymaps
  • Compile a keymap:

    # ./compile <keyboard>/<keymap>
    ./compile crkbd/limi7break
  • To update the QMK firmware submodule to the latest commit:

    git submodule update --remote --merge