diff options
| author | Priyadi Iman Nurcahyo <priyadi@priyadi.net> | 2016-11-26 13:11:40 +0700 |
|---|---|---|
| committer | Priyadi Iman Nurcahyo <priyadi@priyadi.net> | 2016-11-26 13:11:40 +0700 |
| commit | 4b0d16cd7bdcd41cffb17a7b6eed7cb44beaef34 (patch) | |
| tree | c98de94283462f11a085403f540a85c91bf52831 /keyboards/handwired/promethium/keymaps/readme.md | |
| parent | 631b8999a737ec73610f8b569b1f775cadf08172 (diff) | |
My Promethium keyboard firmware
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 0000000000..527691389e --- /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 + + |