~ruther/qmk_firmware

ref: c5fb6b4348dc01aa02846bf7b56e1b0a8a11013c qmk_firmware/docs/api_overview.md -rw-r--r-- 913 bytes
c5fb6b43 — DavidSannier Refactoring successive press() -> release() calls (#23573) 1 year, 7 months ago

#QMK API

The QMK API provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by QMK. The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.

#App Developers

If you are an app developer interested in using this API in your application you should head over to Using The API.

#Keyboard Maintainers

If you would like to enhance your keyboard's support in the QMK Compiler API head over to the Keyboard Support section.

#Backend Developers

If you are interested in working on the API itself you should start by setting up a Development Environment, then check out Hacking On The API.