QMK Firmware Linked

This repo seperates the offical qmk_firmware repo from my customizations to it by synlinking in new files (existing files cannot be modified).

Prerequisites

• QMK CLI (python3 -m pip install qmk) installed and setup (qmk doctor)
• stow (sudo apt install stow)

Repo Setup

# Init
git submodule add https://github.com/qmk/qmk_firmware.git

# Update
git submodule update --init --recursive

# Setup qmk home
# May require manual configuration in qmk.ini
qmk config user.qmk_home=$(pwd)/qmk_firmware
qmk config user.keyboard=splitkb/kyria
qmk config user.keymap=buckwich

My Boards

qmk compile -kb splitkb/kyria -km buckwich qmk compile -kb handwired/knob qmk compile -kb handwired/numpad qmk compile -kb handwired/modular

Usage

• Update qmk_firmware

git submodule update --init --recursive

• Link files (You can then use qmk as you normally would)

stow --target=qmk_firmware linked

• Unlink files

stow --delete --target=qmk_firmware linked

• c to json

qmk c2json linked/keyboards/splitkb/kyria/keymaps/buckwich/keymap.c -km buckwich -kb splitkb/kyria -o buckwich.json

• json to custom c

node ../keyboard-converter/dist/bin/index.js \
--kbf ./linked/keyboards/splitkb/kyria/keymaps/buckwich/info.matrix.json \
--kmf ./linked/keyboards/splitkb/kyria/keymaps/buckwich/buckwich.json \
--qct ./linked/keyboards/splitkb/kyria/keymaps/buckwich/keymap.template.c \
--o ./linked/keyboards/splitkb/kyria/keymaps/buckwich/keymap.c

Tip for WSL

copy to windows with random addon

qmk compile -kb handwired/numpad -km default

cp ./qmk_firmware/.build/handwired_numpad_default.hex /mnt/c/Users/sstei/Documents/

My common builds

qmk compile -kb tekskey/rpfull -km via # compile
qmk flash -kb tekskey/rpfull -km via # compile & flash

qmk via2json -kb tekskey/rpfull linked/keyboards/tekskey/rpfull/keymaps/via/tekskey.via-keymap.json > linked/keyboards/tekskey/rpfull/keymaps/via/tekskey.qmk-keymap.json # via to qmk json
qmk json2c linked/keyboards/tekskey/rpfull/keymaps/via/tekskey.qmk-keymap.json

chrome://device-log/ sudo chmod 777 /dev/hidrawXXX