diff options
author | Daniel <danielallendeutsch@gmail.com> | 2016-08-31 22:15:47 -0600 |
---|---|---|
committer | Daniel <danielallendeutsch@gmail.com> | 2016-08-31 22:15:47 -0600 |
commit | dbac9f495469854fb64a424b171235e46161d799 (patch) | |
tree | 8c1b5d5b6e287fdedc5092383333b2ddb44bc4f4 /keyboards/handwired/minorca/keymaps/readme.md | |
parent | 8019a074cfe39e2bf04c35bb5fb40c9ff9cda9a4 (diff) | |
parent | e28d151a8a1d458f3c18897c6095decc17b0c3a1 (diff) |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/handwired/minorca/keymaps/readme.md')
-rw-r--r-- | keyboards/handwired/minorca/keymaps/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/handwired/minorca/keymaps/readme.md b/keyboards/handwired/minorca/keymaps/readme.md new file mode 100644 index 0000000000..058923ba25 --- /dev/null +++ b/keyboards/handwired/minorca/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 Minorca keymaps + +* **default** default Minorca layout +* **rgb** layout with WS2812b control |