summaryrefslogtreecommitdiffstats
path: root/keyboards/planck/keymaps/ab/README.md
diff options
context:
space:
mode:
authorChristopher Browne <cbbrowne@ca.afilias.info>2016-06-23 11:34:50 -0400
committerChristopher Browne <cbbrowne@ca.afilias.info>2016-06-23 11:34:50 -0400
commita4bdb0ac0e6d44c9c9a2d8910a5ca5b7fb49fcbf (patch)
tree3176e2795f69064d861a7343bd29cedd0d8d4825 /keyboards/planck/keymaps/ab/README.md
parent0cd017d485f19a2c9ce5e8df3535d44958664ea7 (diff)
parentbab6a8fde5a43eb6feeb81b83d29791cbef3af8e (diff)
Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/planck/keymaps/ab/README.md')
-rw-r--r--keyboards/planck/keymaps/ab/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/ab/README.md b/keyboards/planck/keymaps/ab/README.md
new file mode 100644
index 0000000000..d6280f074d
--- /dev/null
+++ b/keyboards/planck/keymaps/ab/README.md
@@ -0,0 +1,18 @@
+# Practical keymap for Planck Ortholinear 40% Mechanical Keyboard
+A practical keymap that emulates standard QWERTY keyboard for Planck. Once you get comfortable with this keymap, you may fork and customize it for your own needs.
+
+![Layout](keyboard-layout.png "Practical Keymap")
+![Photo](keyboard-photo.jpg "Planck Keyboard")
+
+* Online keyboard layout editor: http://goo.gl/mlLAFZ
+
+# Programming Instructions:
+Enter into programming mode and run the following command.
+```
+$ sudo KEYMAP=ab make dfu
+```
+# Notes
+* Simultaneous RAISE+LOWER enters CUSTOM layer. You may add your own macros and custom keys here.
+* RAISE and LOWER also acts as PgUp and PgDn when tapped.
+* [CapsLock] also acts as [Ctrl] key when you press and hold. It is convenient for GNU Emacs users.
+* Bracket keys are placed in the center of the keyboard for programmer's convenience.