This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.
The docs are powered by VitePress. They are also viewable offline; see Previewing the Documentation for more details.
You can request changes by making a fork and opening a pull request.
The project also includes community support for lots of other keyboards.
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.
qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.
https://docs.qmk.fm/newbs_getting_started
python3 -m pip install --user qmk
git clone ...
cd qmk_firmware
qmk setup
To be able to flash, set hardware.keyboard.qmk.enable = true
.
Then:
nix-shell -p qmk
- bdn9
- quefrency-r1 (Home, primary)
- quefrency-r2 (Home, spare)
- quefrency-r3 (Office)
- sinc
git checkout master
git pull upstream master
git push origin master
git checkout jo-m
git merge master
git push origin jo-m