diff options
| author | dbroqua <dbroqua@mousur.org> | 2016-12-17 22:25:21 +0100 |
|---|---|---|
| committer | dbroqua <dbroqua@mousur.org> | 2016-12-17 22:25:21 +0100 |
| commit | df50bee5a88cacbd1f5fab98b26c2068646b61c0 (patch) | |
| tree | 60a59d80c173055788e66b7e9dd79aaad7b27df6 /keyboards/handwired/promethium/keymaps/readme.md | |
| parent | 46b93f02d570c0bb66410cb8d9af2451d5453635 (diff) | |
| parent | 13c4080a1d77cb1dfdf48df8a42e78b9dc483912 (diff) | |
Merge branch 'master' of https://github.com/Dbroqua/qmk_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 + + |