sporq/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
44e098ef2d
qmk-firmware/keyboard/planck/keymaps/README.md
Christopher Browne 498455403e Renaming planck/cbbrowne in keeping with recent naming conventions (#405) 
* More documentation

* Saving crontab for user  on host

* Restructuring in keeping with recent changes to conventions

* Simplify submitting my fave cbbrowne keystroke by using SEND_STRING()

* Local change, not apropos to have in this repo

* Simplify logic; no need to return so much
2016-06-13 19:06:32 -04:00

785 B
Raw Blame History

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