diff options
| author | Didier Loiseau <didierloiseau+git@gmail.com> | 2016-09-11 01:26:47 +0200 |
|---|---|---|
| committer | Didier Loiseau <didierloiseau+git@gmail.com> | 2016-09-11 01:26:47 +0200 |
| commit | b9014c757599ca288be07629ad1d00ef66c033f1 (patch) | |
| tree | ba056e704e76327c597e25d1be200c4c991efeb8 /keyboards/planck/keymaps/readme.md | |
| parent | 60a826923d5a6b0dbe416b0837608149ab82e470 (diff) | |
| parent | 5010df3d8b68a53c382b853c7c2e45922975b631 (diff) | |
| download | qmk_firmware-b9014c757599ca288be07629ad1d00ef66c033f1.tar.gz qmk_firmware-b9014c757599ca288be07629ad1d00ef66c033f1.zip | |
Merge remote-tracking branch 'remotes/jackhumbert/master' into bépo
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 |