diff options
| author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-13 16:06:03 -0400 |
|---|---|---|
| committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-13 16:06:03 -0400 |
| commit | dc9bf78f2b1d7d894576d87ea9bfc86d7bb3deee (patch) | |
| tree | 44f432118882f9176ef6d901dc3d389d28737254 /keyboard/planck/keymaps/README.md | |
| parent | d649ab34334ff568448c47a04fcf40f1aa960135 (diff) | |
| parent | 25d4772754186b8ab6ef86c28049da67a460f123 (diff) | |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboard/planck/keymaps/README.md')
| -rw-r--r-- | keyboard/planck/keymaps/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboard/planck/keymaps/README.md b/keyboard/planck/keymaps/README.md new file mode 100644 index 0000000000..9152353017 --- /dev/null +++ b/keyboard/planck/keymaps/README.md @@ -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
\ No newline at end of file |