diff options
| author | skullY <skullydazed@gmail.com> | 2020-02-23 22:37:25 -0800 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
| commit | 99850aabcad51dd4a46ee10c0f5349a4266084fe (patch) | |
| tree | d59c25726ec8aa7209f15329a194f87f195de11d /docs/api_overview.md | |
| parent | 3c98854044066744ad79d8abc27d93951860af6d (diff) | |
Add API documentation
Diffstat (limited to 'docs/api_overview.md')
| -rw-r--r-- | docs/api_overview.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/api_overview.md b/docs/api_overview.md new file mode 100644 index 0000000000..91d317f06b --- /dev/null +++ b/docs/api_overview.md @@ -0,0 +1,15 @@ +# 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](http://qmk.fm/). 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](api_docs.md). + +## Keyboard Maintainers + +If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support.md) section. + +## Backend Developers + +If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment.md), then check out [Hacking On The API](api_development_overview.md). |