Add keymapmaster

1 files changed, 32 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..fefecd1
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,32 @@
+# Custom keymap for the Sofle v2
+
+Features:
+
+- Various modes, can be switched (using Adjust layer and the selected one is stored in EEPROM).
+- Modes for Qwerty and Colemak support
+- Modes for Mac vs Linux/Win support -> different order of modifiers and different action shortcuts on the "UPPER" layer. Designed to simplify transtions when switching between operating systems often.
+- The OLED on master half shows selected mode and caps lock state and is rotated.
+- Left encoder controls volume up/down/mute. Right encoder PREV/NEXT media controls.
+- Keyboard lock, change to the adjust layer (up and down pressed at the same time) and press the left shift to lock/unlock, current lock state is displayed on oled
+- Apple logo for Mac mode, Fedora Silverblue logo for Linux/Win mode, Lock icon for locked
+- Fixed flickering on main OLED
+- Gaming layout, switches space to the left half of the keyboard and raises the most left column up by one key
+- Automated Keymash generator
+
+# Luna, the keyboard pet
+
+Features:
+- Luna reacts to your wpm counter
+    - under 10 wpm she sits
+    - between 10 and 40 wpm she walks
+    - over 40 wpm she runs
+- She will move sneakily if you hold down Ctrl
+- Will bark at people on the internet if you activate Caps Lock!
+- Luna jumps every time you hit Space
+
+# Keymash generator
+Instead of going through the effort to manually keymash, one can enter (or leave if already entered) Keymash mode by going to the lower layer and pressing on the right encoder.
+
+Once in keymash mode, the wanted length can be entered through the number keys, the values are added, meaning that if a length of 20 is wanted, a double tap on the `0` (0 is 10) results in the length 20.
+
+If the wanted length is entered, pressing enter will unleash the keyboard and keymash.