diff options
author | Jack Humbert <jack.humb@gmail.com> | 2016-06-23 22:18:20 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-06-23 22:18:20 -0400 |
commit | 13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b (patch) | |
tree | 2777e5c95bad3f5a9773fc58524a6ad99df63738 /keyboards/planck/keymaps/readme.md | |
parent | ba116ceb496011bb35ce074a3ba8c2448f059260 (diff) | |
download | qmk_firmware-13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b.tar.gz |
Backlight abstraction and other changes (#439)
* redoes matrix pins, abstracts backlight code for B5,6,7
* slimming down keyboard stuff, backlight breathing implemented
* don't call backlight init when no pin
* cleans up user/kb/quantum calls, keyboard files
* fix pvc atomic
* replaces CHANNEL with correct var in breathing
* removes .hexs, updates readmes, updates template
* cleans-up clueboards, readmes to lowercase
* updates readme
Diffstat (limited to 'keyboards/planck/keymaps/readme.md')
-rw-r--r-- | keyboards/planck/keymaps/readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/readme.md b/keyboards/planck/keymaps/readme.md new file mode 100644 index 000000000..54fb5f6d9 --- /dev/null +++ b/keyboards/planck/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 |