mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-15 16:35:15 +00:00
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 compiling
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