Merge pull request #16 from jackhumbert/master

Forked from jackhumbert/qmk_firmware

1 files changed, 56 insertions, 0 deletions

diff --git a/keyboards/atreus62/keymaps/mneme/README.md b/keyboards/atreus62/keymaps/mneme/README.md
new file mode 100644
index 0000000000..04ab070be6
--- /dev/null
+++ b/keyboards/atreus62/keymaps/mneme/README.md
@@ -0,0 +1,56 @@
+<!-- -*- 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)
+    - [Nav layer](#nav-layer)
+    - [Sym layer](#sym-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 a *` : Application switching based on position in start menu. Very specific to my computer.
+
+
+## Nav layer
+
+![Nav 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.
+
+- `eq` : Tapdance, produces `===` and `!==`
+- `fun`: Tapdance, produces `=>` and `() => {\n`
+
+# License
+  GPL-3+