summaryrefslogtreecommitdiff
path: root/keyboards/v60_type_r/keymaps/xtonhasvim/readme.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 19:43:45 +1100
committerAlex Ong <the.onga@gmail.com>2019-01-04 19:43:45 +1100
commit2bb2977c133646c4e056960e72029270d77cc1eb (patch)
tree235d491f992121ac1716c5bf2fafb80983748576 /keyboards/v60_type_r/keymaps/xtonhasvim/readme.md
parenta55c838961c89097ab849ed6cb1f261791e6b9b4 (diff)
parent47c91fc7f75ae0a477e55b687aa0fc30da0a283c (diff)
Merge branch 'master' into debounce_refactor
# Conflicts: # tmk_core/common/keyboard.c
Diffstat (limited to 'keyboards/v60_type_r/keymaps/xtonhasvim/readme.md')
-rw-r--r--keyboards/v60_type_r/keymaps/xtonhasvim/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/v60_type_r/keymaps/xtonhasvim/readme.md b/keyboards/v60_type_r/keymaps/xtonhasvim/readme.md
new file mode 100644
index 0000000000..541faed2ba
--- /dev/null
+++ b/keyboards/v60_type_r/keymaps/xtonhasvim/readme.md
@@ -0,0 +1,20 @@
+KB Paradise V60 Type R Xton Has Vim! Layout
+======================
+
+If you don't look closely, this layout mimics the default layout fairly well. Care
+is taken to match the FN layer to the keycaps that the TypeR comes with. I wrote this layout
+for a keyboard that I'm giving my intern as a parting gift and wanted it to be as easy to learn
+as possible.
+
+The key differences:
+
+- Holding capslock down activates the movement layer, much like the vimouse layout except that I'm using the xtonhasvim movement layer.
+- Capslock+return (or right-control) activates vim mode!
+
+## Keymap Notes
+
+- Alternate underglow modes are not supported. Instead the underglow is used to indicate state. It can be turned off and dimmed. Polestar underglow LEDs are not individually addressable, sadly.
+
+### Build
+
+To build this keymap, simply run `make v60_type_r:xtonhasvim` from the root project directory. Flash using QMK Toolbox