keyboard/planck/keymaps/README.md

   1 # How to add your own keymap
   2
   3 Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding `_`:
   4
   5     _[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author]
   6
   7 \* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements
   8
   9 and contain the following files:
  10
  11 * `keymap.c`
  12 * `readme.md` *recommended*
  13 * `config.h` *optional*, found automatically when compiling
  14 * `Makefile` *optional*, found automatically when compling
  15
  16 When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format:
  17
  18      * **folder_name** description
  19
  20 # List of Planck keymaps
  21
  22 * **default** default Planck layout
  23 * **cbbrowne** cbbrowne's Planck layout