diff options
| author |  Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-22 11:26:26 -0400 |
|---|---|---|
| committer | Christopher Browne <cbbrowne@ca.afilias.info> | 2016-06-22 11:26:26 -0400 |
| commit | b0caf32741cf415a45333828f1661d9f6b72570f (patch) | |
| tree | 5e2b8203ab232c0a89264e96716ebf1a859f6189 /keyboards/planck/keymaps/README.md | |
| parent | ee3c7892ad585e2e702d8975420d25ae052d97bb (diff) | |
| parent | 8c1bfdf0bd9aae13d8722fd107deca40ffc7932c (diff) | |
| download | qmk_firmware-b0caf32741cf415a45333828f1661d9f6b72570f.tar.gz | |
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 000000000..54fb5f6d9 --- /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 |