summaryrefslogtreecommitdiff
path: root/keyboards/hadron/keymaps/readme.md
diff options
context:
space:
mode:
authorThat-Canadian2017-07-14 21:35:50 -0400
committerThat-Canadian2017-07-14 21:35:50 -0400
commit6c9b69a4b67e064dacea364f842bf15631d7a5e6 (patch)
treef5afa578f218d83245363b68bfb502f517698af6 /keyboards/hadron/keymaps/readme.md
parente2e0f5d6d13f6e4d2528ee9ff5e48f896d637092 (diff)
parent5412229603c1b16051776e81bed57697adf339e2 (diff)
Merge branch 'master' into minidox
Diffstat (limited to 'keyboards/hadron/keymaps/readme.md')
-rw-r--r--keyboards/hadron/keymaps/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/hadron/keymaps/readme.md b/keyboards/hadron/keymaps/readme.md
new file mode 100644
index 000000000..54fb5f6d9
--- /dev/null
+++ b/keyboards/hadron/keymaps/readme.md
@@ -0,0 +1,23 @@
+# 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 \ No newline at end of file