adds planck keymap readme
This commit is contained in:
parent
bdf94c0621
commit
3e3a07fc97
1 changed files with 22 additions and 0 deletions
22
keyboard/planck/keymaps/README.md
Normal file
22
keyboard/planck/keymaps/README.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# 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` *recommended*
|
||||
* `config_user.h` *optional*, found automatically when compiling
|
||||
* `makefile.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
|
Loading…
Reference in a new issue