History

kemonine 1eca167714 Add 'S' to customized base layer of big ardux mode		2024-04-17 13:09:30 +00:00
..
.devcontainer	add docker setup for vscode to ease launching dev environment for qmk	2022-01-22 10:50:41 -05:00
puckbuddy	add way to trip booting to uf2 on puck buddy ; (hold rgb_toggle)	2022-06-11 09:09:41 -04:00
users	Add 'S' to customized base layer of big ardux mode	2024-04-17 13:09:30 +00:00
.gitignore	start work on qmk user keymaps	2022-01-21 21:03:57 -05:00
README.md	first working code/builds of qmk tidbit customizations	2022-01-22 01:04:45 -05:00

README.md

QMK Notes

Inspiration

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

Compiling

cd /qmk_firmware/users/kemonine
qmk compile keymaps/tidbit.json

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)/users/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
cd /qmk_firmware/keyboards/nullbitsco
if [ -d tidbit ];
then
cd tidbit;
git pull;
else
git clone https://github.com/nullbitsco/tidbit tidbit
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