summaryrefslogtreecommitdiff
path: root/keyboards/handwired/minorca/keymaps/readme.md
diff options
context:
space:
mode:
authorJason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
committerJason Janse van Rensburg <l33tjas.0n@gmail.com>2016-08-30 14:54:00 +0200
commitfc2ca62a3b9552175eb7c27cc11f3a5af6cfae50 (patch)
tree59b2f2406f472a9fd2af4946420d1a1c880929c0 /keyboards/handwired/minorca/keymaps/readme.md
parenta41a7a9100b9f4c6bfdf49b39b05e626ffd95397 (diff)
parent8e00c464e6f488d86e0768a77a2ad5ee238dba6d (diff)
downloadqmk_firmware-fc2ca62a3b9552175eb7c27cc11f3a5af6cfae50.tar.gz
qmk_firmware-fc2ca62a3b9552175eb7c27cc11f3a5af6cfae50.zip
Merge branch 'master'
Conflicts: keyboards/planck/keymaps/bone2planck/keymap.c
Diffstat (limited to 'keyboards/handwired/minorca/keymaps/readme.md')
-rw-r--r--keyboards/handwired/minorca/keymaps/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/handwired/minorca/keymaps/readme.md b/keyboards/handwired/minorca/keymaps/readme.md
new file mode 100644
index 0000000000..058923ba25
--- /dev/null
+++ b/keyboards/handwired/minorca/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 Minorca keymaps
+
+* **default** default Minorca layout
+* **rgb** layout with WS2812b control