diff options
| author | That-Canadian <poole.chris.11@gmail.com> | 2017-07-15 03:34:37 +0200 |
|---|---|---|
| committer | That-Canadian <poole.chris.11@gmail.com> | 2017-07-15 03:34:37 +0200 |
| commit | 5412229603c1b16051776e81bed57697adf339e2 (patch) | |
| tree | 088e5e6d1d0d448f0e5c4032a830c27b33a126ab /keyboards/hadron/keymaps/readme.md | |
| parent | d73d30aa846f4378b8f1fa072a4620520b3c1953 (diff) | |
| parent | 6ed8ce4f598f838b971aa290a499f852827e1b58 (diff) | |
| download | qmk_firmware-5412229603c1b16051776e81bed57697adf339e2.tar.gz qmk_firmware-5412229603c1b16051776e81bed57697adf339e2.tar.xz | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/hadron/keymaps/readme.md')
| -rw-r--r-- | keyboards/hadron/keymaps/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/hadron/keymaps/readme.md b/keyboards/hadron/keymaps/readme.md new file mode 100644 index 000000000..54fb5f6d9 --- /dev/null +++ b/keyboards/hadron/keymaps/readme.md @@ -0,0 +1,23 @@ +# 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 Planck keymaps + +* **default** default Planck layout +* **cbbrowne** cbbrowne's Planck layout
\ No newline at end of file |