mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-24 20:32:58 +00:00
.. | ||
alexey | ||
angerthosenear | ||
austin | ||
bone2planck | ||
brandon | ||
cbbrowne | ||
charlie | ||
daniel | ||
david | ||
default | ||
dzobert | ||
experimental | ||
gabriel | ||
jacob | ||
joe | ||
kyle | ||
leo | ||
lucas | ||
lukas | ||
max | ||
mollat | ||
nico | ||
pete | ||
pvc | ||
tak3over | ||
unicode | ||
yang | ||
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_user.h
optional, found automatically when compilingmakefile.mk
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 Planck keymaps
- default default Planck layout
- cbbrowne cbbrowne's Planck layout