aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/promethium/keymaps/readme.md
diff options
context:
space:
mode:
authorclimbalima <climbalima@gmail.com>2016-12-10 23:15:47 -0500
committerclimbalima <climbalima@gmail.com>2016-12-10 23:15:47 -0500
commit73d60182969023984ff275117d49a4824c6987d0 (patch)
treefdac811b117c49f78de04c407d4bef76e6df5772 /keyboards/handwired/promethium/keymaps/readme.md
parent56515ba5034e83c598891686cfdc43c186e5d487 (diff)
parent985a091a739c99736d5b17de5161831488dbc219 (diff)
downloadfirmware-73d60182969023984ff275117d49a4824c6987d0.tar.gz
firmware-73d60182969023984ff275117d49a4824c6987d0.tar.bz2
firmware-73d60182969023984ff275117d49a4824c6987d0.zip
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
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 000000000..527691389
--- /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
+
+