diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-05 11:21:37 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-06-05 11:21:37 -0400 |
| commit | 3e3a07fc97d66d5f001aa3da4496d1268f4797cc (patch) | |
| tree | f990493882fe47d3335146f75481c7b1edd251c2 /keyboard/planck/keymaps | |
| parent | bdf94c0621c4d1293618cab9589e593c3d713852 (diff) | |
adds planck keymap readme
Diffstat (limited to 'keyboard/planck/keymaps')
| -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 |