keyboard/qmk

QMK Notes

Inspiration

• https://git.sr.ht/~sungo/qmk_userspace/tree/main

Compiling

qmk compile -kb tidbit -km kemonine

Docker Critical

Docker Run

# PowerShell
#     Use ` instead of \
#     Use ${PWD} instead of $(pwd)
docker run --rm -it \
  -v qmk_firmware:/qmk_firmware \
  -v ${PWD}/.build:/qmk_firmware/.build \
  -v ${PWD}/kemonine:/qmk_firmware/users/kemonine \
  qmkfm/qmk_cli /bin/bash

Update / Clone Sources

# PowerShell
#     Use ` instead of \
docker run --rm -it `
  -v qmk_firmware:/qmk_firmware \
  qmkfm/qmk_cli /bin/bash

cd /qmk_firmware
if [ -d .git ]; 
then 
git pull; 
else 
git clone https://github.com/qmk/qmk_firmware.git .; 
fi

Docker Volumes

QMK Sources

qmkfm/qmk_cli lacks sources. Use named volume to speed dev and output

KemoNine

Need to have the qmk/users/kemonine directory mounted at /qmk_firmware/users/kemonine in Docker container

Build output

Need to have a local dir for build artifact extraction at /qmk_firmware/.build