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 | |
| parent | bdf94c0621c4d1293618cab9589e593c3d713852 (diff) | |
| download | qmk_firmware-3e3a07fc97d66d5f001aa3da4496d1268f4797cc.tar.gz qmk_firmware-3e3a07fc97d66d5f001aa3da4496d1268f4797cc.zip | |
adds planck keymap readme
Diffstat (limited to 'keyboard/planck')
| -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 000000000..915235301 --- /dev/null +++ b/keyboard/planck/keymaps/README.md | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | # How to add your own keymap | ||
| 2 | |||
| 3 | Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding `_`: | ||
| 4 | |||
| 5 | _[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author] | ||
| 6 | |||
| 7 | \* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements | ||
| 8 | |||
| 9 | and contain the following files: | ||
| 10 | |||
| 11 | * `keymap.c` | ||
| 12 | * `readme.md` *recommended* | ||
| 13 | * `config_user.h` *optional*, found automatically when compiling | ||
| 14 | * `makefile.mk` *optional*, found automatically when compling | ||
| 15 | |||
| 16 | When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format: | ||
| 17 | |||
| 18 | * **folder_name** description | ||
| 19 | |||
| 20 | # List of Planck keymaps | ||
| 21 | |||
| 22 | * **default** default Planck layout \ No newline at end of file | ||