]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/jj40/keymaps/cockpit/readme.md
Improve JJ40 Cockpit documentation (#2729)
[qmk_firmware.git] / keyboards / jj40 / keymaps / cockpit / readme.md
1 # Cockpit custom layout
2
3 > This configuration is built around Lithuanian keyboard layout, but you can easily modify it to fit your needs
4
5 ## Layers
6
7 ### Default QWERTY
8
9 |           |        |        |        |        |        |        |        |        |        |        |           |
10 | :-------: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :-------: |
11 |  <br>Esc  | Q<br>q | W<br>w | E<br>e | R<br>r | T<br>t | Y<br>y | U<br>u | I<br>i | O<br>o | P<br>p | <br>Bksp  |
12 |  <br>Tab  | A<br>a | S<br>s | D<br>d | F<br>f | G<br>g | H<br>h | J<br>j | K<br>k | L<br>l | :<br>; |  "<br>'   |
13 | <br>Shift | Z<br>z | X<br>x | C<br>c | V<br>v | B<br>b | N<br>n | M<br>m | <<br>, | ><br>. | ?<br>/ | <br>Enter |
14 |   Ctrl    |   Fn   |  GUI   |  Alt   | Lower  |   Sp   |  ace   | Raise  |  Left  |  Down  |   Up   |   Right   |
15
16 ### Lower
17
18 |           |        |        |        |           |        |        |        |        |        |         |          |
19 | :-------: | :----: | :----: | :----: | :-------: | :----: | :----: | :----: | :----: | :----: | :-----: | :------: |
20 |  ~<br>\`  | Ą<br>ą | Č<br>č | Ę<br>ę |  Ė<br>ė   | Į<br>į | Š<br>š | Ų<br>ų | Ū<br>ū | Ž<br>ž | \_<br>- | <br>Bksp |
21 |  <br>Tab  | <br>!  | <br>@  | <br>#  |   <br>$   | <br>%  | <br>^  | <br>&  | <br>\* | <br>(  |  <br>)  | <br>Del  |
22 | <br>Shift | <br>=  | <br>+  | <br>-  |  <br>\|   | {<br>[ | }<br>] | <br><  | <br>>  | <br>{  |  <br>}  | <br>Ins  |
23 |   Ctrl    |        |        |  Alt   | **Lower** |   Sp   |  ace   |        |  Home  |  PgDn  |  PgUp   |   End    |
24
25 ### Raise
26
27 |           |        |         |        |        |        |        |           |         |        |        |           |
28 | :-------: | :----: | :-----: | :----: | :----: | :----: | :----: | :-------: | :-----: | :----: | :----: | :-------: |
29 |  ~<br>\`  | !<br>1 | @<br>2  | #<br>3 | $<br>4 | %<br>5 | ^<br>6 |  &<br>7   | \*<br>8 | (<br>9 | )<br>0 | <br>Bksp  |
30 |  <br>Tab  | $<br>4 | %<br>5  | ^<br>6 |        |        |        |           |         |        |        | \|<br>\   |
31 | <br>Shift | &<br>7 | \*<br>8 | (<br>9 | )<br>0 |        |        |           | <<br>,  | ><br>. | ?<br>/ | <br>Enter |
32 |   Ctrl    |        |         |  Alt   |        |   Sp   |  ace   | **Raise** |  Left   |  Down  |   Up   |   Right   |
33
34 ### Function
35
36 *   Caps does not work. Might be an issue with my laptop, not JJ40 specific.
37 *   Backlight breathing does not work.
38 *   **Term** button is bound to `Calculator`. I have set this button as a shortcut to open a terminal.
39 *   **Lock** is a shortcut for `Alt + L`
40
41 |           |             |             |             |             |            |              |            |        |         |         |          |
42 | :-------: | :---------: | :---------: | :---------: | :---------: | :--------: | :----------: | :--------: | :----: | :-----: | :-----: | :------: |
43 |  <br>F1   |   <br>F2    |   <br>F3    |   <br>F4    |   <br>F5    |   <br>F6   |    <br>F7    |   <br>F8   | <br>F9 | <br>F10 | <br>F11 | <br>F12  |
44 | <br>Caps  | RGB<br>Togl | RGB<br>Hue+ | RGB<br>Sat+ | RGB<br>Brt+ | BL<br>Togl | BL<br>Breath | BL<br>Brt+ |        |         |         | <br>Vol+ |
45 | <br>Shift |  <br>Term   | RGB<br>Hue- | RGB<br>Sat- | RGB<br>Brt- |  WWW<br><  |   WWW<br>>   | BL<br>Brt- |        |         |  PrScr  | <br>Vol- |
46 |   Ctrl    |   **Fn**    | RGB<br>Mode |     Alt     |             |     Sp     |     ace      |   MPrev    | MStop  |  MNext  |  MPlay  |   Lock   |
47
48 ## Usage
49
50 ```bash
51 cd qmk_firmware
52 make jj40:cockpit
53 bootloadHID .build/jj40_cockpit.hex
54 ```
55
56 _if you're getting permission errors use sudo_