summaryrefslogtreecommitdiffstats
path: root/keyboards/boston_meetup/2019/keymaps/readme.md
diff options
context:
space:
mode:
authorishtob <ishtob@gmail.com>2019-04-22 23:26:51 -0400
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-22 20:26:51 -0700
commitce8fb1eab923a8ce37022a898597048e5893b078 (patch)
treeeaf6e163d0ac625ed5fb333ce27f6aaed840e390 /keyboards/boston_meetup/2019/keymaps/readme.md
parenta2cec0594b15dc667adf7f1b0e35cb698dc1758d (diff)
Boston meetup 2019 (#5611)
* Add boston_meetup folder for community meetup macropads * Modify OLED indicators to match macropad * PR cleanup * Spelling fix Co-Authored-By: ishtob <ishtob@gmail.com> * convert custom matrix to standard matrix defines * refactor layer define with enum * Remove un-used files * remove "\" in keymap
Diffstat (limited to 'keyboards/boston_meetup/2019/keymaps/readme.md')
-rw-r--r--keyboards/boston_meetup/2019/keymaps/readme.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/boston_meetup/2019/keymaps/readme.md b/keyboards/boston_meetup/2019/keymaps/readme.md
new file mode 100644
index 0000000000..c10a49f7d0
--- /dev/null
+++ b/keyboards/boston_meetup/2019/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 2019 keymaps
+
+* **default** default 2019 macropad layout \ No newline at end of file