qmk_firmware/keyboards/planck/keymaps/readme.md

# 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 compiling

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
adds planck keymap readme 2016-06-05 17:21:37 +02: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
updates all config.h and Makefiles to correct references, text 2016-06-21 16:21:43 +02:00			* `config.h` optional, found automatically when compiling
Update readme.md (#12502) Noticed a letter missing in "compiling". 2021-04-11 12:46:43 +02:00			* `Makefile` optional, found automatically when compiling
adds planck keymap readme 2016-06-05 17:21:37 +02:00
			`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`

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-14 01:06:32 +02:00			`* default default Planck layout`
Update readme.md (#12502) Noticed a letter missing in "compiling". 2021-04-11 12:46:43 +02:00			`* cbbrowne cbbrowne's Planck layout`