mirror of https://github.com/qmk/qmk_firmware
52906ad4ba | ||
---|---|---|
.. | ||
default | ||
framtava | ||
mason | ||
planck | ||
xtonhasvim | ||
readme.md |
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.c
readme.md
recommendedconfig.h
optional, found automatically when compilingMakefile
optional, 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 keymaps
- default default layout from KBDFans
- mason
- planck Planck default layout
- xtonhasvim A Planck-like layout with a few tweaks and a vim emulation layer.