Skip to content

Commit

Permalink
Remove unused keyboard generation template docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tzarc committed Jun 15, 2024
1 parent 35fa841 commit a464dc6
Showing 1 changed file with 0 additions and 25 deletions.
25 changes: 0 additions & 25 deletions docs/keyboard_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,3 @@ By default the template that QMK Compiler has is very limited. You can only spec
# Keyboard Metadata

To aid Web and GUI programs that wish to use this API we are publishing metadata about keyboards. You can use this metadata to get information about the keyboard like Manufacturer, Product and Vendor ID's, Processor, and more. This data is populated from the [qmk_firmware](https://github.com/qmk/qmk_firmware) repository.

## Available Metadata

# Keymap Templates

QMK Compiler builds a keymap based on the layout you submit in your JSON payload. To do it makes use of a template file to generate that keymap.

## Default Template

This is the default template that QMK Compiler uses:

```c
#include QMK_KEYBOARD_H

// Helpful defines
#define _______ KC_TRNS

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
__KEYMAP_GOES_HERE__
};
```

## Supplying Your Own Template

If you'd like to supply a custom template you can do so. Create a directory named `templates` inside your keyboard's directory, next to `keymaps`. If QMK Compiler finds a file named `keymap.c` it will use that as your keyboard's template. Make sure that you have the string `__KEYMAP_GOES_HERE__` inside your template so QMK Compiler knows where to insert the keymap.

0 comments on commit a464dc6

Please sign in to comment.