~ruther/qmk_firmware

ref: a23b918baf83fe46715a3b01d7cc58d4ac6016bd qmk_firmware/docs/api_overview.md -rw-r--r-- 901 bytes
a23b918b — Rutherther Updates I lost track of 27 days 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.

Do not follow this link