aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/hadron/keymaps/readme.md
diff options
context:
space:
mode:
authorishtob <ishtob@gmail.com>2017-07-11 13:53:50 -0400
committerJack Humbert <jack.humb@gmail.com>2017-07-11 13:53:50 -0400
commitcc6db9c5408ad303b9d3f47e4deaf78b4fc854d3 (patch)
tree1995e0fdfc41de938723752478eb6d45c2f7b2c3 /keyboards/hadron/keymaps/readme.md
parent886af3250722f0aac2a8d37771ef8fe6b937f4cb (diff)
downloadfirmware-cc6db9c5408ad303b9d3f47e4deaf78b4fc854d3.tar.gz
firmware-cc6db9c5408ad303b9d3f47e4deaf78b4fc854d3.tar.bz2
firmware-cc6db9c5408ad303b9d3f47e4deaf78b4fc854d3.zip
Adds Hadron Keyboard (#1492)
* adding hadron keymaps * fix embedded comment * fixed TWI driver path * Delete glcdfont.c * Delete ssd1306.c * Delete ssd1306.h * Update readme.md
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