qmk_firmware/keyboard/planck/keymaps
Christopher Browne 4e1bc2d298 Add docs
2016-06-15 11:25:08 -04:00
..
alexey Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
angerthosenear Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
austin Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
bone2planck Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
brandon Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
cbbrowne Add docs 2016-06-15 11:25:08 -04:00
charlie Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
daniel Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
david Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
default Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
dzobert Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
experimental Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
gabriel Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
jacob Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
joe Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
kyle Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
leo Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
lucas Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
lukas Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
max Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
mollat Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
nico Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
pete Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
pvc Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
tak3over Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
unicode Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
yang Makefile redo & other features (#395) 2016-06-11 13:31:31 -04:00
README.md Restructuring in keeping with recent changes to conventions 2016-06-13 16:27:33 -04:00

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_user.h optional, found automatically when compiling
  • makefile.mk 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