diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-06-22 04:39:54 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-22 04:39:54 +0200 |
| commit | 649b33d7783cf3021928534b7ae127e0a89e8807 (patch) | |
| tree | c2b5e0cf8ff4aa2918e3b88ab75dbdb071cc0a1d /keyboards/planck/keymaps/README.md | |
| parent | 464c8e274f993d3571fe5ea5e836fe55a3912ffe (diff) | |
| download | qmk_firmware-649b33d7783cf3021928534b7ae127e0a89e8807.tar.gz qmk_firmware-649b33d7783cf3021928534b7ae127e0a89e8807.tar.xz | |
Renames keyboard folder to keyboards, adds couple of tmk's fixes (#432)
* fixes from tmk's repo
* rename keyboard to keyboards
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 |