summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/ab/readme.md
diff options
context:
space:
mode:
authorNathan Sharfi2016-07-31 14:02:25 -0700
committerNathan Sharfi2016-07-31 14:02:25 -0700
commitd889648d5373b7ff77dc7bc4b369c628e8336b45 (patch)
tree35c6eb194417242958baf54b36f0ff3a56e378f1 /keyboards/ergodox/keymaps/ab/readme.md
parent6428069eb70f5cc47ac1f3f9acf3daea14fb9097 (diff)
parentb25dbc484d639210c53d8e13f79cf5a77f2faaaa (diff)
Merge branch 'master' of github.com:jackhumbert/qmk_firmware
# Conflicts: # keyboard/ergodox_ez/keymaps/zweihander-osx/keymap.c # keyboard/ergodox_ez/keymaps/zweihander-osx/zweihander-osx.hex
Diffstat (limited to 'keyboards/ergodox/keymaps/ab/readme.md')
-rw-r--r--keyboards/ergodox/keymaps/ab/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/ab/readme.md b/keyboards/ergodox/keymaps/ab/readme.md
new file mode 100644
index 000000000..6b1ac2be3
--- /dev/null
+++ b/keyboards/ergodox/keymaps/ab/readme.md
@@ -0,0 +1,21 @@
+# Beginner's keymap for Ergodox-EZ
+Beginner's keymap emulates standard QWERTY keyboard for beginners. Once you get comfortable with the Ergodox-EZ, you may fork this keymap and customize it for your own needs or find a suitable one from the community contributed keymaps.
+
+![Beginner's Keymap](keyboard-layout.png)
+
+#### Pros
+* Easier to switch between regular keyboards and Ergodox-EZ.
+* Easy on beginners. It has everything you need for your day to day usage.
+
+#### Cons
+* Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/jackhumbert/qmk_firmware/blob/master/keyboards/ergodox_ez/keymaps/default/readme.md)
+* While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys.
+
+#### Notes
+* Ideally number key [6] should have started from the right-hand side of the keyboard. Doing so breaks the familiar QWERTY layout.
+* Quote key ['] should have been placed between [:] and [Enter]. Due to lack of key space, it is placed below [Enter].
+* Double [Alt] keys are placed adjacent to each other for convenience.
+* [CapsLock] also acts as [Ctrl] key when you press and hold. It is convenient for GNU Emacs users.
+* Additional bracket keys are placed in the center of the keyboard for programmer's convenience.
+
+