keyboards/jj40/keymaps/ajp10304/readme.md

   1 # AJP10304 Custom JJ40 Layout
   2 ###Based on my Planck layout of the same name.
   3
   4 **Note:** In the tables below where there are two characters on a key,
   5 the second is the output when shift is applied.
   6
   7 **Note:** The below tables assume a UK layout.
   8
   9 ##### Main Qwerty Layer
  10
  11 * Tab: when held, operates as shift.
  12 * Enter: when held, operates as shift.
  13 * MENU: perform right-click
  14
  15 |      |      |      |      |      |      |      |      |      |      |      |      |
  16 | ---- |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| ----:|
  17 | Esc  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
  18 | Tab  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |  ;:  | Enter|
  19 | Shft |   Z  |   X  |   C  |   V  |   B  |   N  |   M  |  ,<  |  .>  |  /?  | Shft |
  20 | Fn   | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Raise | Shift| MENU | Ctrl | Fn   |
  21
  22 ##### Function Layer
  23 Activated when `fn` held in the above `qwerty` layer.
  24
  25 |       |      |      |      |      |      |      |      |      |      |      |      |
  26 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  27 |  F1   |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
  28 |  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  |  ~   |INSERT|
  29 | Shift |  \|  |  `¬  |  #~  |   *  |  -_  |  =+  |  \|  |  [{  |  ]}  |  '@  |Shift |
  30 | Fn    | Ctrl | Alt  | GUI  |Lower | Bksp |Space |Raise | MENU | Alt  | Ctrl | Fn   |
  31
  32 ##### Lower Layer
  33 Activated when `Lower` is held in the above `qwerty` layer.
  34
  35 * Numbers are along the top row, their shifted counterparts are on row 2.
  36 * WrdBks: `backspace` with `ctrl` applied. I.e. delete a word.
  37 * WrdDel: `delete` with `ctrl` applied. I.e. forward delete a word.
  38
  39 |       |      |      |      |      |      |      |      |      |      |      |      |
  40 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  41 |  1!   |  2"  |  3£  |  4$  |  5%  |  6^  |  7&  |  8*  |  9(  |  0)  | DEL  | Bksp |
  42 |  !    |   "  |   £  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |WrdDel|WrdBks|
  43 | Shift |  \|  |  `¬  |  #~  |  '@  |  -_  |  =+  |  #~  |  [{  |  ]}  |  '@  |Shift |
  44 |       |      |      |      |Lower | Del  |Space |      | Next | Vol- | Vol+ | Play |
  45
  46  ##### Raise Layer
  47  Activated when `Raise` is held in the above `qwerty` layer.
  48
  49  * Preferred layer for typing brackets.
  50  * Allows for cursor navigation to be used solely with the right hand.
  51  * WRDSEL: Select the word where the cursor is.
  52  * |< and >|: Apply `ctrl` to `left` and `right` respectively for word jumping.
  53
  54 |       |      |      |      |      |      |       |      |      |      |       |      |
  55 | :---: |:----:| :---:| :---:| :---:| :---:| :---: | :---:| :---:| :---:| :---: | :---:|
  56 |   `   |      |WRDSEL|  [   |   ]  |      |       | PGUP | HOME |PGDOWN|       |PRNTSC|
  57 |   `   |      |      |  (   |   )  |      |       | HOME |  UP  | END  |       |ZOOM +|
  58 |       |      |      |  {   |   }  |      |&#124;<| LEFT | DOWN |RIGHT |>&#124;|ZOOM -|
  59 |       |      |      |      |      |  Alt | Enter |Raise |      |      |       |      |
  60
  61 ##### Lower + Raise
  62 Activated when `Lower` and `Raise` are held together the above `qwerty` layer.
  63
  64 * Audio controls in the same position as cursor keys from the `Raise` layer.
  65 * ????: Runs a macro for outputting a text string.  Do not use this store passwords.
  66 * Reset: Enter bootloader for flashing firmware to the keyboard.
  67 * CAPS: Toggle caps lock.
  68 * DYN: Enter `DYN` layer.
  69 * MAC: Toggle MAC OS extensions to layers. This allows MLWR to be enabled with LOWER,
  70 MRSE with RAISE and MFNC with FUNC respectively.
  71
  72 |       |      |      |      |      |      |      |      |      |      |      |      |
  73 | :---: |:----:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  74 | ????  | Reset|Qwerty|      |      |      |      |      |      |      |      |  Del |
  75 | CAPS  |      |      |      |      |      |      | Mute | Vol+ | Play |      |      |
  76 | MAC   |      |      |      |      |      |      | Prev | Vol- | Next |      |      |
  77 |       |      |      |      |      |      |      |      | DYN  |      |      |      |
  78
  79 ##### DYN
  80 Activated when `DYN` held along with `Lower` and `Raise`
  81 Allows recording of macros.  To start recording the macro, press either REC1 or REC2.
  82 To finish the recording, press STOP. To replay the macro, press either PLAY1 or PLAY2.
  83
  84 |       |      |      |      |      |      |      |      |      |      |      |      |
  85 | :---: | :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:| :---:|
  86 |       |      |      |      |      | REC1 | REC2 |      |      |      |      |      |
  87 |       |      |      |      |      | PLAY1| PLAY2|      |      |      |      |      |
  88 |       |      |      |      |      | STOP | STOP |      |      |      |      |      |
  89 |       |      |      |      |      |      |      |      |      |      |      |      |
  90
  91
  92 ####Manual Flashing of hex file
  93 `bootloadHID -r .build/jj40_ajp10304.hex`