summaryrefslogtreecommitdiffstats
path: root/keyboards/planck/keymaps/ajp10304/readme.md
diff options
context:
space:
mode:
authorajp10304 <a.Pocklington@Gmail.com>2017-10-23 19:28:52 +0100
committerJack Humbert <jack.humb@gmail.com>2017-10-23 08:28:52 -1000
commita08287b0a0800e0add34fa9c0c4916d2bf8d5db1 (patch)
tree373c0c18b960ba3204ee05c448f372ceebdf8750 /keyboards/planck/keymaps/ajp10304/readme.md
parentaf83c6a4cb76098eb5798324e9727c7d923ce046 (diff)
Added ajp10304 Planck layout (#1887)
* Added ajp10304 Planck layout * Removed Makefile from planck ajp10304 keymap
Diffstat (limited to 'keyboards/planck/keymaps/ajp10304/readme.md')
-rw-r--r--keyboards/planck/keymaps/ajp10304/readme.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/ajp10304/readme.md b/keyboards/planck/keymaps/ajp10304/readme.md
new file mode 100644
index 0000000000..6e6bde014d
--- /dev/null
+++ b/keyboards/planck/keymaps/ajp10304/readme.md
@@ -0,0 +1,86 @@
+# AJP10304 Custom Planck Layout
+
+**Note:** In the tables below where there are two characters on a key,
+the second is the output when shift is applied.
+
+**Note:** The below tables assume a UK layout.
+
+##### Main Qwerty Layer
+
+* Tab: when held, operates as shift.
+* Enter: when held, operates as shift.
+* MENU: perform right-click
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
+| Esc | Q | W | E | R | T | Y | U | I | O | P | Bksp |
+| Tab | A | S | D | F | G | H | J | K | L | ;: | Enter|
+| Shft | Z | X | C | V | B | N | M | ,< | .> | /? | Shft |
+| Fn | Ctrl | Alt | GUI |Lower | Bksp |Space |Raise | Shift| MENU | Ctrl | Fn |
+
+##### Function Layer
+Activated when `fn` held in the above `qwerty` layer.
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
+| F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 |
+| 1! | 2" | 3£ | 4$ | 5% | 6^ | 7& | 8* | 9( | 0) | ~ |INSERT|
+| Shift| \| | `¬ | #~ | * | -_ | =+ | \| | [{ | ]} | '@ |Shift |
+| Fn | Ctrl | Alt | GUI |Lower | Bksp |Space |Raise | MENU | Alt | Ctrl | Fn |
+
+##### Lower Layer
+Activated when `Lower` is held in the above `qwerty` layer.
+
+* Numbers are along the top row, their shifted counterparts are on row 2.
+* WrdBks: `backspace` with `ctrl` applied. I.e. delete a word.
+* WrdDel: `delete` with `ctrl` applied. I.e. forward delete a word.
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
+| 1! | 2" | 3£ | 4$ | 5% | 6^ | 7& | 8* | 9( | 0) | DEL | Bksp |
+| ! | " | £ | $ | % | ^ | & | * | ( | ) |WrdDel|WrdBks|
+| Shift| \| | `¬ | #~ | '@ | -_ | =+ | #~ | [{ | ]} | '@ |Shift |
+| | | | |Lower | Del |Space | | Next | Vol- | Vol+ | Play |
+
+ ##### Raise Layer
+ Activated when `Raise` is held in the above `qwerty` layer.
+
+ * Preferred layer for typing brackets.
+ * Allows for cursor navigation to be used solely with the right hand.
+ * WRDSEL: Select the word where the cursor is.
+ * |< and >|: Apply `ctrl` to `left` and `right` respectively for word
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----:
+| ` | |WRDSEL| [ | ] | | | PGUP | HOME |PGDOWN| |PRNTSC|
+| ` | | | ( | ) | | | HOME | UP | END | |ZOOM +|
+| | | | { | } | | |< | LEFT | DOWN |RIGHT | >| |ZOOM -|
+| | | | | | Alt | Enter|Raise | | | | |
+
+##### Lower + Raise
+Activated when `Lower` and `Raise` are held together the above `qwerty` layer.
+
+* Audio controls in the same position as cursor keys from the `Raise` layer.
+* ????: Runs a macro for outputting sensitive information. Do not use this store passwords.
+* Reset: Enter bootloader for flashing firmware to the keyboard.
+* CAPS: Toggle caps lock.
+* DYN: Enter `DYN` layer.
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----:
+| ???? | Reset|Qwerty| | | | | | | | | Del |
+| CAPS | | | | | | | Mute | Vol+ | Play | | |
+| | | | | | | | Prev | Vol- | Next | | |
+| | | | | | | | DYN | | | |
+
+##### DYN
+Activated when `DYN` held along with `Lower` and `Raise`
+Allows recording of macros. To start recording the macro, press either REC1 or REC2.
+To finish the recording, press STOP. To replay the macro, press either PLAY1 or PLAY2.
+
+| | | | | | | | | | | | |
+| ---- |:----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| -----:
+| | | | | | REC1 | REC2 | | | | | |
+| | | | | | PLAY1| PLAY2| | | | | |
+| | | | | | STOP | STOP | | | | | |
+| | | | | | | | | | | |