QMK fork with my personal keymaps
My keyboard: keyboards/beekeeb/piantor_pro
Compile firmware:
qmk compile -kb beekeeb/piantor_pro -km default
# Or to automatically flash:
qmk flash -kb beekeeb/piantor_pro -km default
Initializing the fork
# Make a fork on github.com
git clone https://github.com/your-username/qmk_firmware.git
cd qmk_firmware
git remote add upstream https://github.com/qmk/qmk_firmware.git
Make changes and commit
git add *
git commit -am "commit message"
git push origin master
Merge updates from qmk/qmk_firmware
git fetch upstream
git checkout master
git merge upstream/master
git push origin master
git clone [email protected]:LilleAila/qmk_firmware ~/qmk_firmware
cd ~/qmk_firmware
git submodule init
# Remember to enable `hardware.keyboard.qmk.enable` in NixOS!!
nix-shell
qmk setup
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.