Readme + minor change to make it match reality.

diff --git a/keyboards/atreus62/keymaps/mneme/README.md b/keyboards/atreus62/keymaps/mneme/README.md
index 54f5e21ab056c4a89bb96a6b9b08c969fe8012ff..b4dc89625b7876968a8f12acdb8de60f98c9d2dd 100644 (file)
--- a/keyboards/atreus62/keymaps/mneme/README.md
+++ b/keyboards/atreus62/keymaps/mneme/README.md
@@ -1,2 +1,54 @@
-Keymap that owes just about everything to Algernon.
-Check out his keymap for the Ergodox. It's pretty damned amazing.
+<!-- -*- mode: markdown; fill-column: 8192 -*- -->
+
+Mnemes Swedish Bonaza
+=======================
+
+My Layout in process, most of the code is shamelessly stolen from [algernons][algernon] excellent layout
+
+ [algernon]: https://github.com/algernon/ergodox-layout
+
+It's for Windows (current work forces me to) and Swedish (matter of birth) so ymmw.
+
+## Table of Contents
+
+* [Layouts](#layouts)
+    - [Base layer](#base-layer)
+    - [Fun layer](#fun-layer)
+    - [Nav layer](#nav-layer)
+    - [LED states](#led-states)
+
+# Layouts
+
+## Base layer
+
+![Base layer](img/base.png)
+
+
+* The number row doubles as a function row. Short presses produces numbers, long presses produces Fxx
+* The `Shift`, `Alt`, and `Control` modifiers are one-shot.
+* `Backspace` and `Enter` doubles as switches to the `sym` layer when held
+* The `ESC` key also doubles as a one-shot cancel key.
+* The **Lead** key is followed by a sequence of keys.
+    - `LEAD l`   : `lgui+l`.
+    - `LEAD s l` : `λ`.
+    - `LEAD s s` : `¯\_(ツ)_/¯`
+    - `LEAD s f` : `凸(ツ)凸`
+    - `LEAD f s` : `ctrl+s`
+    - `LEAD b d` : `ctrl+w`
+
+
+## Nav layer
+
+![Fun layer](img/fun.png)
+
+Basic navigation on the right hand and modifiers close
+by for the left. The latter because I tend to use `ctrl+arrows` quite a lot.
+
+## Sym layer
+
+![Sym layer](img/sym.png)
+
+Easy access to most symbols I use on a daily basis. Most common are on the home row, the rest are grouped as best as I could.
+
+# License
+  GPL-3+

diff --git a/keyboards/atreus62/keymaps/mneme/img/base.png b/keyboards/atreus62/keymaps/mneme/img/base.png
new file mode 100644 (file)
index 0000000..86907d5
Binary files /dev/null and b/keyboards/atreus62/keymaps/mneme/img/base.png differ

diff --git a/keyboards/atreus62/keymaps/mneme/img/fun.png b/keyboards/atreus62/keymaps/mneme/img/fun.png
new file mode 100644 (file)
index 0000000..a58933d
Binary files /dev/null and b/keyboards/atreus62/keymaps/mneme/img/fun.png differ

diff --git a/keyboards/atreus62/keymaps/mneme/img/sym.png b/keyboards/atreus62/keymaps/mneme/img/sym.png
new file mode 100644 (file)
index 0000000..11b5bd4
Binary files /dev/null and b/keyboards/atreus62/keymaps/mneme/img/sym.png differ

diff --git a/keyboards/atreus62/keymaps/mneme/keymap.c b/keyboards/atreus62/keymaps/mneme/keymap.c
index 8c3f8aa43597eae5b2a402ddc6e9b885e896c432..56d6371204312d8f8eea7e77c4e71ebfb35a68d0 100644 (file)
--- a/keyboards/atreus62/keymaps/mneme/keymap.c
+++ b/keyboards/atreus62/keymaps/mneme/keymap.c
@@ -44,7 +44,7 @@
 #define KN_CIRC LSFT(KN_UMLA)   // ^
 #define KN_ASTR LSFT(KN_QUOT)   // *
 #define KN_TILD RALT(KN_UMLA)   // ~
-#define KN_BSLS RALT(KN_PLUS)   // 
+#define KN_BSLS RALT(KN_PLUS)   //
 
 #define OSM_LCTL OSM(MOD_LCTL)
 #define OSM_LALT OSM(MOD_LALT)
@@ -110,8 +110,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   [NAV] = {
 
    { KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS },
-   { KC_TRNS  ,KC_TRNS  ,KC_HOME  ,KC_UP    ,KC_END   ,KC_PGUP  ,KC_NO   ,KC_PGUP  ,KC_HOME  ,KC_UP    ,KC_END   ,KC_TRNS  ,KC_TRNS },
-   { KC_TRNS  ,KC_TRNS  ,KC_LEFT  ,KC_DOWN  ,KC_RIGHT ,KC_PGDN  ,KC_NO   ,KC_PGDN  ,KC_LEFT  ,KC_DOWN  ,KC_RIGHT ,KC_TRNS  ,KC_TRNS },
+   { KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_NO   ,KC_PGUP  ,KC_HOME  ,KC_UP    ,KC_END   ,KC_TRNS  ,KC_TRNS },
+   { KC_TRNS  ,KC_TRNS  ,KC_LSFT  ,KC_LCTL  ,KC_LALT  ,KC_TRNS  ,KC_NO   ,KC_PGDN  ,KC_LEFT  ,KC_DOWN  ,KC_RIGHT ,KC_TRNS  ,KC_TRNS },
    { KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_F11  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS },
    { KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_F12  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_TRNS  ,KC_VOLD  ,KC_VOLU }
 
@@ -281,19 +281,13 @@ void matrix_scan_user(void) {
       unregister_code(KC_LCTRL);
     }; // Todo
 
-    SEQ_ONE_KEY(KC_SLSH){
-      register_code(KC_LCTRL);
-      TAP_ONCE(KC_F);
-      unregister_code(KC_LCTRL);
-    }
-
     SEQ_TWO_KEYS (KC_S, KC_S) {
       // ¯\_(ツ)_/¯
       unicode_input_start(); register_hex(0xaf); unicode_input_finish();
-      register_code (KC_RALT); TAP_ONCE (KN_PLUS); unregister_code (KC_RALT); 
+      register_code (KC_RALT); TAP_ONCE (KN_PLUS); unregister_code (KC_RALT);
       register_code (KC_RSFT); TAP_ONCE (KC_8); unregister_code (KC_RSFT);
       unicode_input_start (); register_hex(0x30c4); unicode_input_finish();
-      register_code (KC_RSFT); TAP_ONCE (KC_9); TAP_ONCE(KC_7); unregister_code (KC_RSFT); 
+      register_code (KC_RSFT); TAP_ONCE (KC_9); TAP_ONCE(KC_7); unregister_code (KC_RSFT);
       unicode_input_start (); register_hex(0xaf); unicode_input_finish();
     }
 
@@ -302,7 +296,7 @@ void matrix_scan_user(void) {
       unicode_input_start(); register_hex(0x51F8); unicode_input_finish();
       register_code (KC_RSFT); TAP_ONCE (KC_8); unregister_code (KC_RSFT);
       unicode_input_start (); register_hex(0x30c4); unicode_input_finish();
-      register_code (KC_RSFT); TAP_ONCE (KC_9); unregister_code (KC_RSFT); 
+      register_code (KC_RSFT); TAP_ONCE (KC_9); unregister_code (KC_RSFT);
       unicode_input_start (); register_hex(0x51F8); unicode_input_finish();
     }