aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/kinesis/keymaps/xyverz/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kinesis/keymaps/xyverz/readme.md')
-rw-r--r--keyboards/kinesis/keymaps/xyverz/readme.md131
1 files changed, 130 insertions, 1 deletions
diff --git a/keyboards/kinesis/keymaps/xyverz/readme.md b/keyboards/kinesis/keymaps/xyverz/readme.md
index da033be1e..3433a94c5 100644
--- a/keyboards/kinesis/keymaps/xyverz/readme.md
+++ b/keyboards/kinesis/keymaps/xyverz/readme.md
@@ -1 +1,130 @@
-# The default keymap for kinesis-advantage
+# Xyverz's Kinesis Keymap
+
+## About this keymap:
+
+The Dvorak layout shown here stems from my early Kinesis years, using the Contour PS/2 with a Dvorak software layout. Because of this, the RBRC and LBRC were on opposite sides of the board in the corner keys. I've decided to continue using this layout with my QMK Kinesis.
+
+The QWERTY layout shown here is based entirely on the Kinesis Advantage layout. The Colemak layout is merely an adaptation of that.
+
+I've enabled persistent keymaps for Qwerty, Dvorak and Colemak layers, similar to the default Planck layouts.
+
+## Still to do:
+
+ * Need to figure out a better position for the ESC key.
+ * Come up with a function for the empty keys shown in the alpha layers below.
+ * Fix the CapsLock, NumLock, and ScrLck LEDs.
+
+### Function Keys on All Layers (keypad toggles):
+ ,-----------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 |
+ `-----------------------------------------------------------------'
+ ,-----------------------------------------------------------------.
+ | F9 | F10 | F11 | F12 | PScr | SLck | Paus | Keypad | RESET |
+ `-----------------------------------------------------------------'
+
+### Layer 0: Dvorak layer
+
+ ,-------------------------------------------.,-------------------------------------------.
+ | ] | 1 | 2 | 3 | 4 | 5 || 6 | 7 | 8 | 9 | 0 | [ |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | Tab | ' | , | . | P | Y || F | G | C | R | L | \ |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | CapsLk | A | O | E | U | I || D | H | T | N | S | - |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | X || B | M | W | V | Z | RShift |
+ `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+ | ` | INS | Left | Rght | | Up | Dn | / | = |
+ `---------------------------' `---------------------------'
+ ,--------------.,--------------.
+ |Ctr/ESC| LAlt || RGUI |Ctr/ESC|
+ ,------|-------|------||------+-------+-------.
+ | | Del | Home || PgUp | Enter | |
+ | BkSp | / |------||------| / | Space |
+ | | Media | End || PgDn | KeyPd | |
+ `---------------------'`----------------------'
+
+### Layer 1: QWERTY layer
+
+ ,-------------------------------------------.,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 || 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T || Y | U | I | O | P | \ |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | CapsLk | A | S | D | F | G || H | J | K | L | ; | ' |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | B || N | M | , | . | / | RShift |
+ `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+ | ` | INS | Left | Rght | | Up | Dn | [ | ] |
+ `---------------------------' `---------------------------'
+ ,--------------.,--------------.
+ |Ctr/ESC| LAlt || RGUI |Ctr/ESC|
+ ,------|-------|------||------+-------+-------.
+ | | Del | Home || PgUp | Enter | |
+ | BkSp | / |------||------| / | Space |
+ | | Media | End || PgDn | KeyPd | |
+ `---------------------'`----------------------'
+
+### Keymap 2: Colemak layer
+
+ ,-------------------------------------------.,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 || 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | Tab | Q | W | F | P | G || J | L | U | Y | ; | \ |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | BkSpc | A | R | S | T | D || H | N | E | I | O | ' |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | LShift | Z | X | C | V | B || K | M | , | . | / | RShift |
+ `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+ | ` | INS | Left | Rght | | Up | Dn | [ | ] |
+ `---------------------------' `---------------------------'
+ ,--------------.,--------------.
+ |Ctr/ESC| LAlt || RGUI |Ctr/ESC|
+ ,------|-------|------||------+-------+-------.
+ | | Del | Home || PgUp | Enter | |
+ | BkSp | / |------||------| / | Space |
+ | | Media | End || PgDn | KeyPd | |
+ `---------------------'`----------------------'
+
+### layer 3 : Media layer
+
+ ,-------------------------------------------.,-------------------------------------------.
+ | F11 | F1 | F2 | F3 | F4 | F5 || F6 | F7 | F8 | F9 | F10 | F12 |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | | | | | | || | | | | | |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | | | | | | || | Mute | Vol- | Vol+ | | |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | | | | | | || Stop | Prev | Play | Next | Sel | |
+ `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+ | | | | | | | | | |
+ `---------------------------' `---------------------------'
+ ,-------------.,-------------.
+ | | || | |
+ ,------|------|------||------+------+------.
+ | | | || | | |
+ | | |------||------| | |
+ | | | || | | |
+ `--------------------'`--------------------'
+
+
+
+### Keymap 4: Keypad layer
+
+ ,-------------------------------------------.,-------------------------------------------.
+ | Power | | | | | || | NmLk | KP = | KP / | KP * | |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | Sleep | | | | | || | KP 7 | KP 8 | KP 9 | KP - | |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | Wake | | | | | || | KP 4 | KP 5 | KP 6 | KP + | |
+ |--------+------+------+------+------+------||------+------+------+------+------+--------|
+ | | |QWERTY|Colemk|Dvorak| || | KP 1 | KP 2 | KP 3 |KP Ent| |
+ `--------+------+------+------+------+------'`------+------+------+------+------+--------'
+ | | | | | | | | KP . |KP Ent| |
+ `---------------------------' `----------------------------------'
+ ,-------------.,-------------.
+ | | || | |
+ ,------|------|------||------+------+------.
+ | | | || | | |
+ | | |------||------| | KP 0 |
+ | | | || | | |
+ `--------------------'`--------------------'