Skip to content

qmk

prerequisites

make sure you've...

  • installed git and python

    sudo apt install -y git python3-pip

    sudo pacman -S --noconfirm git python-pip libffi

installing qmk

1
2
mkdir ~/qmk_firmware
cd ~/qmk_firmware

make sure you've...

3
4
5
python -m pip install qmk
qmk setup $GH_USER/qmk_firmware # (1)!
qmk config user.keymap=$GH_USER
  1. $GH_USER is your github username

updating qmk_firmware

make sure you've...

1
2
3
4
5
6
cd ~/qmk_firmware
git fetch upstream
git merge upstream/master
git add .
git commit -m "Merged upstream into master"
git push

compiling firmware

make sure you've...

1
2
cd ~/qmk_firmware
qmk compile -kb $KEYBOARD # (1)!
  1. e.g. $KEYBOARD is crkbd or kbdfans/kbd67/mkiirgb/v2

flashing firmware

make sure you've...

1
2
cd ~/qmk_firmware
qmk flash

resources