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.
Clone this repo, enter it and:
make git-submodule
python3 -m pip install --user qmk
qmk setup
Make my firmware using:
make keychron/k4/rgb/v2:wrock
Flash the firmware:
Go to the sonix-flasher package
pip3 install -r requirements.txt fbs run First time: Short the boot pins under the spacebar and plug in the keyboard After flashing: Fn+Esc to go to bootloader mode use 0x00 offset. Select the .bin in the qmk_firmware folder
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.