Flash
Flash: make <keyboard>
Supported keyboards:
- naked48
- ferris
- ffkb
- sweeeeep
- cannonball
- oxymoroon
Install
- Install qmk & qmk cli: https://qmk.github.io/qmk_mkdocs/master/en/tutorial_getting_started/
- Initialize firmware submodule:
cd /path/to/keymaps;
git submodule update --init --recursive
- Set qmk config
qmk config user.qmk_home=~/path/to/keymaps/qmk_firmware
- Verify with
qmk doctor
- clone fingerpunch fork for ffkb and Taro Hayashi fork (ensure you check out tarohayashi branch) for cannonball.
- Rename
local-install-template.sh
aslocal-install.sh
and update paths.
Keymap
TODO
Mentions
- (Article) Separate keymap repo for QMK
- Keymap/features/userspace
- Keymap Visualization
Development
Update qmk firmware
git submodule foreach git pull origin master
Unlink
Remove symlinks in qmk firmware:
make unlink