diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-11-26 13:40:42 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-26 13:40:42 -0500 |
| commit | 1585fc4b616cb28b8d4a418cd31c8ce0dd64f731 (patch) | |
| tree | 5545f416f9ca3f10d43d8010fa91a53b710bfb64 /keyboards/handwired/promethium/keymaps/readme.md | |
| parent | b5c811bde5387203405c9f94c5455cf1d3ca865a (diff) | |
| parent | 12c1314b024b0e24dc561d8f8816561a4ca8ff42 (diff) | |
Merge pull request #908 from priyadi/promethium
My handwired 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 + + |