aboutsummaryrefslogtreecommitdiff
path: root/qmk/keyboards/sofle_choc/keymaps/custom/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'qmk/keyboards/sofle_choc/keymaps/custom/readme.rst')
-rw-r--r--qmk/keyboards/sofle_choc/keymaps/custom/readme.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/qmk/keyboards/sofle_choc/keymaps/custom/readme.rst b/qmk/keyboards/sofle_choc/keymaps/custom/readme.rst
new file mode 100644
index 0000000..075dc97
--- /dev/null
+++ b/qmk/keyboards/sofle_choc/keymaps/custom/readme.rst
@@ -0,0 +1,48 @@
+Effects
+=======
+
+Shift key / CapsLock
+--------------------
+
+The right shift key can be used to switch into capslock if the key is pressed
+without any other key.
+
+The keyboard will exit the mode by either:
+- The `KC_ESCAPE` key
+- The `KC_LSHFT` key
+- another action of the key `KC_RSHFT`
+
+Left and Right Control
+----------------------
+
+The `KC_F` and `KC_J` keys can be used to activate the respective left and right
+control keys.
+
+A mecanism tries to detect if the
+
+Layers
+======
+
+There are two layers, one for the numeric keypad, and one for the navigation
+arrow.
+
+The numeric keypad
+------------------
+
+This layer is mostly located on the left part of the keyboard, and is activated
+with the right layer key.
+
+The navigation arrows layer
+---------------------------
+
+This layer is located on the right part of the keyboard and is activated with
+the left layer key.
+
+Combos with other keys
+----------------------
+
+The navigation layer is automatically activated when the key `KC_LGUI` is
+pressed :
+
+- In windows this allow to move a window automatically (with `KC_LGUI` + arrows)
+- In Linux, this allow to map the key `mod4` + arrows to move between windows