QMK Logo QMK Firmware

The goal of the QMK software project is to develop a completely customizable, powerful, and enjoyable firmware experience for any project - keyboard or otherwise - and to provide helpful, encouraging, and kind support and feedback for people with any software development experience.

View on GitHub

Current Version Discord Docs Status GitHub contributors GitHub forks


This project is maintained by QMK collaborators and contributors like you!

Hosted on GitHub Pages — Theme by orderedlist


Making from root and no more Makefiles

After merging in the implementation of #1659, the only way to compile QMK is in the root directory, with the full command:

make <keyboard>[-<subproject>]-<keymap>-<target>

where the subproject is optional. Errors associated with trying to build anywhere else may be:

QMK Firmware v0.5.125
error: pathspec 'keyboards/<keyboard>/lib/chibios' did not match any file(s) known to git.
Did you forget to 'git add'?
make: *** [<keyboard>-allsp-allkm] Error 1


make: *** No rule to make target `default'.  Stop.

In addition to this change, the only Makefile that should exist is the one in the QMK root - all others have been/should be converted to rules.mk, which is now included in its stead, at every level:

If you see any Makefile in any of these locations, you can feel free to delete it.