diff options
| author | James Young <xxiinophobia@yahoo.com> | 2020-02-25 17:22:05 -0800 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
| commit | d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb (patch) | |
| tree | 312220f2751e444dba3864de8a70d29a5ec98cda /docs/reference_configurator_support.md | |
| parent | 503b52652c82add2daf84112c745e3e744c10e77 (diff) | |
| download | firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.tar.gz firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.tar.bz2 firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.zip | |
Polish Configurator section
Diffstat (limited to 'docs/reference_configurator_support.md')
| -rw-r--r-- | docs/reference_configurator_support.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/docs/reference_configurator_support.md b/docs/reference_configurator_support.md index 58c1a2d20..88676ba97 100644 --- a/docs/reference_configurator_support.md +++ b/docs/reference_configurator_support.md @@ -10,11 +10,11 @@ To understand how the Configurator understands keyboards, first one must underst ``` |---------------| |NLk| / | * | - | -|---+---+-------| +|---+---+---+---| |7 |8 |9 | + | -|---+---+---| │ +|---+---+---| | |4 |5 |6 | | -|---+---+-------| +|---+---+---+---| |1 |2 |3 |Ent| |-------+---| | |0 | . | | @@ -130,18 +130,20 @@ Use the `keyboard_name` object to set the name of the keyboard. For instruction The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows: ``` - ┌ The name of the key. Not displayed in the Configurator. - │ ┌ The key's X-axis location, in key units from the - │ │ keyboard's left edge. - │ │ ┌ The key's Y-axis location, in key units from - │ │ │ the keyboard's top (rear-facing) edge. + The name of the key. Not displayed in the Configurator. + | + | The key's X-axis location, in key units from the + | | keyboard's left edge. + | | + | | The key's Y-axis location, in key units from + | | | the keyboard's top (rear-facing) edge. ↓ ↓ ↓ {"label":"Num Lock", "x":0, "y":0}, ``` Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively. -?> For more on the `info.json` files, see [QMK Keyboard Guidelines: Keyboard Metadata](hardware_keyboard_guidelines.md?id=keyboard-metadata) +?> For more on the `info.json` files, see [`info.json` Format](reference_info_json.md). ## How the Configurator Programs Keys |