diff options
| author | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-24 12:19:34 -0400 |
|---|---|---|
| committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-24 12:19:34 -0400 |
| commit | 4d79e224384464c8b42c770b3da09b9655d359e7 (patch) | |
| tree | 7d14e742352d2237ab19fe49985bbacef47d7e6d /keyboards/planck/keymaps/readme.md | |
| parent | a4bdb0ac0e6d44c9c9a2d8910a5ca5b7fb49fcbf (diff) | |
| parent | 40bfc7231e87c883c840967fdbe42a7c711805be (diff) | |
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/planck/keymaps/readme.md')
| -rw-r--r-- | keyboards/planck/keymaps/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/readme.md b/keyboards/planck/keymaps/readme.md new file mode 100644 index 0000000000..54fb5f6d9e --- /dev/null +++ b/keyboards/planck/keymaps/readme.md @@ -0,0 +1,23 @@ +# 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.h` *optional*, found automatically when compiling +* `Makefile` *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
\ No newline at end of file |