Skip to content

Commit a8959a2

Browse files
ids1024jackpot51
authored andcommitted
docs: Add a layouts/README.md explaining files
1 parent 5841630 commit a8959a2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

layouts/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
`picker.json` defines the groups of keycodes that appear in the keycode picker. The labels here are used both in the picker and on the keyboard.
2+
3+
Within each layout:
4+
* `default.json` - The default keymap and LED settings, in the same format the Configurator can import/export through its UI.
5+
* `keymap.json` - Maps keycode names to their numerical values.
6+
* `layout.json` - Maps key position to electrical matrix indices.
7+
* `leds.json` - For a keyboard with per-key LEDs, maps key position to LED index.
8+
* `meta.json` - Micellanous values associated with the keyboard.
9+
* `physical.json` - Defines the physical layout of keys, the colors to display as their backgrounds, and labels (only shown in a tab when `--debug-layers` is passed to the Configurator).
10+
11+
Other than `meta.json` and `physical.json`, these files are generated from the EC/QMK source using `layouts.py` from the root of this repository. `meta.json` is written manually, with other keys added by `layouts.py`. `physical.json` is created with <http://www.keyboard-layout-editor.com>.

0 commit comments

Comments
 (0)