[jackhill/qmk/firmware.git] / 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 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
Commit	Line	Data
3e3a07fc JH	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
a8375fa1 JH	13	* `config.h` optional, found automatically when compiling
a8375fa1 JH	14	* `Makefile` optional, found automatically when compling
3e3a07fc JH	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
49845540 CB	22	* default default Planck layout
49845540 CB	23	* cbbrowne cbbrowne's Planck layout