diff options
| author | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
|---|---|---|
| committer | Stanley Lai <stanleylai.sg@gmail.com> | 2016-12-17 13:49:13 -0800 |
| commit | b49d7800aeae1009b39b2bff2121864425e73ce9 (patch) | |
| tree | f73447fc32940c7bc6b691a83567186d1afbc991 /keyboards/handwired/promethium/keymaps/readme.md | |
| parent | 9ecf9073b96799e52a1f1c0d35b57177382902ce (diff) | |
| parent | ae95834f5af7404c04e6fe3446019046278d814b (diff) | |
Merge remote-tracking branch 'refs/remotes/jackhumbert/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 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 + + |