aboutsummaryrefslogtreecommitdiff
path: root/keyboards/handwired/promethium/keymaps/readme.md
diff options
context:
space:
mode:
authorJoshua T <[email protected]>2017-01-07 14:01:21 -0600
committerJoshua T <[email protected]>2017-01-07 14:01:21 -0600
commit8f8d10475956a17953f6db4db3f3b50bd795c0d8 (patch)
tree90c80474baa080e5743ee745ec98254e1a2faadd /keyboards/handwired/promethium/keymaps/readme.md
parentb7b44dc481430438552d91b7069d5e37a5e3a649 (diff)
parente7df488a92da56cf160ac64c8cc7302ab717e145 (diff)
downloadqmk_firmware-8f8d10475956a17953f6db4db3f3b50bd795c0d8.tar.gz
qmk_firmware-8f8d10475956a17953f6db4db3f3b50bd795c0d8.zip
Merged from upstream
Diffstat (limited to 'keyboards/handwired/promethium/keymaps/readme.md')
-rw-r--r--keyboards/handwired/promethium/keymaps/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/handwired/promethium/keymaps/readme.md b/keyboards/handwired/promethium/keymaps/readme.md
new file mode 100644
index 0000000000..527691389e
--- /dev/null
+++ b/keyboards/handwired/promethium/keymaps/readme.md
@@ -0,0 +1,22 @@
+# 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 Promethium keymaps
+
+