0
0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-28 04:19:56 +00:00
qmk_firmware/keyboards/planck/keymaps/readme.md
Jack Humbert 13bb6b4b7f Backlight abstraction and other changes ()
* 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
2016-06-23 22:18:20 -04:00

777 B

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