make git-submodule
util/qmk_install.sh
crkbd: lexjacobs
gergoplex: germ
planck-ez: zsa
germ git@github.com:germ/qmk_firmware.git (fetch)
germ git@github.com:germ/qmk_firmware.git (push)
origin git@github.com:lexjacobs/qmk_firmware.git (fetch)
origin git@github.com:lexjacobs/qmk_firmware.git (push)
upstream git@github.com:qmk/qmk_firmware.git (fetch)
upstream git@github.com:qmk/qmk_firmware.git (push)
zsa git@github.com:zsa/qmk_firmware.git (fetch)
zsa git@github.com:zsa/qmk_firmware.git (push)
for adding another fork/branch:
# example using zsa
git remote add zsa https://github.com/zsa/qmk_firmware.git
git fetch --all
git checkout -B branchname zsa/master
git push -u zsa branchname
For updating / flashing crkbd:
git checkout lexjacobs
qmk compile -kb crkbd -km lexjacobs
then use qmk toolbox to flash
For updating / flashing planck/ez:
git checkout zsa
make git-submodule
make planck/ez:lexjacobs_miryoku:flash
For updating / flashing gergoplex:
git checkout gboards
make git-submodule
make gboards/k/gergoplex:lexjacobs:dfu
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 Docsify and hosted on GitHub. 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, or by clicking the "Edit this page" link at the bottom of any page.
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.