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.
Ensure submodules are in a good state:
qmk git-submodule
qmk compile -kb yunzii/al68 -km bpugh
qmk flash -kb yunzii/al68 -km bpugh
# if already running my keymap: press capslocks+r or capslock+b to enter bootloader
# if running factory: hold space+b while plugging in keyboard.
# in emergencies, try holding escape while plugging in keyboard to enter bootloader mode
qmk compile -kb ploopyco/madromys -km bpugh
# This will generate a ploopyco_trackball_rev1_007_bpugh.uf2 file in current directory
# Hold the bottom-left button while plugging in for bootloader mode
# It will appear as a drive.
cp ploopyco_madromys_rev1_001_bpugh.uf2 /Volumes/RPI-RP2/