summaryrefslogtreecommitdiff
path: root/keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md
diff options
context:
space:
mode:
authornathanvercaemert <50712356+nathanvercaemert@users.noreply.github.com>2020-05-26 14:46:02 -0400
committerGitHub <noreply@github.com>2020-05-26 11:46:02 -0700
commit5d3bf8a050f3c0beb1f91147dc1ab54de36cbb05 (patch)
treef8af457fcfc0168c253cdcfb2d9e1244dd2b77a9 /keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md
parent6501377070ff20bd061ea85c7ae5517652b6478b (diff)
[Keymap] Contributing Home-Row-Centric-Mousekey Layout (#9195)
* adding personal keymap to repository * starting to customize documentation to keymap * updated readme * updated readme
Diffstat (limited to 'keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md')
-rw-r--r--keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md b/keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md
new file mode 100644
index 0000000000..5570d9881c
--- /dev/null
+++ b/keyboards/ergodox_ez/keymaps/nathanvercaemert/readme.md
@@ -0,0 +1,26 @@
+# The nathanvercaemert ErgoDox EZ configuration
+
+Centered around the home row and the use of mouse keys, this configuration focuses
+on minimal finger movement. No key is more than one unit away from a finger on the home row.
+
+## Layers
+
+* Base Layer
+ * The two main thumb keys provide a loop to the mouse key layer. Pressing the left followed by the right always guarantees that you are on the base layer.
+ * There are a lot of dual function keys on the base layer.
+ * The layout of the letters is qwerty.
+ * Pinkys, ring fingers, and middle fingers apply dual function modifiers (along with the keys above and below the ring fingers.)
+* Numbers, Symbols, and Function Keys.
+ * From the base layer, many keys are dual function layer switches.
+ * The switch on one hand changes the home row of the other hand to a row of symbols in most cases.
+ * The left index finger, and the key below it, change the right hand to the numbers and function keys
+ respectfully.
+* Mouse Layer
+ * Clicking the main left thumb key navigates to the mouse layer (10.) Some dual function keys (technically tap dance functions) allow the left hand to apply modifiers to mouse clicks while tapping switches to
+ navigation layers.
+* Navigation Layers
+ * From the Mouse Layer, taps to the left home row navigate to scroll keys, arrow keys, and page keys.
+
+Here is the image of my keymap:
+
+![Default](https://i.imgur.com/kXywQIq.png) \ No newline at end of file