summaryrefslogtreecommitdiff
path: root/keyboards/crkbd/keymaps/thefrey/README.md
diff options
context:
space:
mode:
authorthe-frey <alex@lynh.am>2019-03-10 17:17:43 +0000
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-03-10 10:17:43 -0700
commitad12acd3c049e1eef02ac21bb749eda375e09cec (patch)
treeef1b7d118aa889eac9842d832270c0668a01d223 /keyboards/crkbd/keymaps/thefrey/README.md
parentc8ad13d0f970c7f424ea5da48181ad449f4ae09f (diff)
Add personal keymap for crkbd (#5208)
* Add a crkbd layout with nkro on by default, and an emacs-friendly layout for clojure * Added readme and image * Add changes as requested on PR
Diffstat (limited to 'keyboards/crkbd/keymaps/thefrey/README.md')
-rw-r--r--keyboards/crkbd/keymaps/thefrey/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/crkbd/keymaps/thefrey/README.md b/keyboards/crkbd/keymaps/thefrey/README.md
new file mode 100644
index 0000000000..69b20cfcd6
--- /dev/null
+++ b/keyboards/crkbd/keymaps/thefrey/README.md
@@ -0,0 +1,16 @@
+![the-frey-layout](https://raw.githubusercontent.com/the-frey/the-frey.github.com/master/assets/images/keyboard-layout.jpg)
+
+# Keyboard layout by the-frey
+
+This is a layout that allows access to all the paren keys easily, has a tab on the lower layer (for SUPER-TAB app switching) and some utility features like PGUP/PGDOWN and HOME/END.
+
+In addition, the arrows are on the lower layer and are bound to the vim keys (h,j,k,l). I've found this a productive layout for programming in emacs and hopefully you will too.
+
+The layout image above shows the keymap, with each key marked with all three layers:
+
+- The top indicates the raise layer
+- The middle indicates the default layer
+- The bottom indicates the lower layer
+
+All the keys respond as you'd expect to the 'shift' key - i.e. on a UK/GB keyboard, `/` becomes `?` and so on.
+