forked from mirrors/qmk_firmware
48ff93582b
Instead of having all sendstring keycode mappings in the main quantum.c file, give each one its own file in keymap_extras that can be #included in a user's keymap. If one is included, it will define the appropriate lookup tables and overwrite the weak definitions in quantum.c. (Including more than one sendstring definition will fail at compile time.) Update @rai-suta's test keymap to match, as well as the documentation. |
||
|---|---|---|
| .. | ||
| ab | ||
| alexey | ||
| angerthosenear | ||
| austin | ||
| basic | ||
| bone2planck | ||
| brandon | ||
| callum | ||
| cbbrowne | ||
| chance | ||
| charlie | ||
| circuit | ||
| daniel | ||
| david | ||
| dbroqua | ||
| default | ||
| dshields | ||
| dzobert | ||
| espynn | ||
| experimental | ||
| gabriel | ||
| handwired_binaryplease | ||
| impossible | ||
| jacob | ||
| jeebak | ||
| jeremy-dev | ||
| jhenahan | ||
| joe | ||
| johannes | ||
| khord | ||
| kyle | ||
| lae3 | ||
| leo | ||
| lucas | ||
| lukas | ||
| luke | ||
| max | ||
| mitch | ||
| mollat | ||
| nico | ||
| originerd | ||
| pete | ||
| premek | ||
| priyadi | ||
| pvc | ||
| rai-suta | ||
| sgoodwin | ||
| smt | ||
| tak3over | ||
| thermal_printer | ||
| tong92 | ||
| unicode | ||
| vifon | ||
| xyverz | ||
| yale | ||
| yang | ||
| zach | ||
| readme.md | ||
How to add your own keymap
Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding _:
_[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author]
* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements
and contain the following files:
keymap.creadme.mdrecommendedconfig.hoptional, found automatically when compilingMakefileoptional, found automatically when compling
When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format:
* **folder_name** description
List of Planck keymaps
- default default Planck layout
- cbbrowne cbbrowne's Planck layout