~ruther/qmk_firmware

ref: cc9d0ded3d1d59b27d1ae49946d2be484c1041e7 qmk_firmware/docs/api_overview.md -rw-r--r-- 901 bytes
cc9d0ded — Rutherther feat: caps word modifications 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.

Do not follow this link