diff options
| author | xyverz <xyverz@gmail.com> | 2016-12-06 17:36:19 -0800 |
|---|---|---|
| committer | xyverz <xyverz@gmail.com> | 2016-12-06 17:36:19 -0800 |
| commit | 9216bc73778ef0fe5830b91511f37dd90fb0f0a1 (patch) | |
| tree | 6c9f343c2485150c1912b7b68ade364a232015bd /keyboards/handwired/promethium/keymaps/readme.md | |
| parent | f9cf4f75aec8cb24f054f243b985d9e5c18a2a80 (diff) | |
| parent | 985a091a739c99736d5b17de5161831488dbc219 (diff) | |
| download | firmware-9216bc73778ef0fe5830b91511f37dd90fb0f0a1.tar.gz firmware-9216bc73778ef0fe5830b91511f37dd90fb0f0a1.tar.bz2 firmware-9216bc73778ef0fe5830b91511f37dd90fb0f0a1.zip | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/handwired/promethium/keymaps/readme.md')
| -rw-r--r-- | keyboards/handwired/promethium/keymaps/readme.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/handwired/promethium/keymaps/readme.md b/keyboards/handwired/promethium/keymaps/readme.md new file mode 100644 index 000000000..527691389 --- /dev/null +++ b/keyboards/handwired/promethium/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.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 Promethium keymaps + + |