From 0c4a6bf2dbeb66fe9b4637874d6bb8ad86e73364 Mon Sep 17 00:00:00 2001 From: Domantas Petrauskas Date: Wed, 11 Apr 2018 20:20:00 +0300 Subject: [PATCH] Improve JJ40 Cockpit documentation (#2729) * Add JJ40 Cockpit keymap * Fix lower layer symbols * Improve documentation JJ40 Cockpit --- keyboards/jj40/keymaps/cockpit/keymap.c | 4 +- keyboards/jj40/keymaps/cockpit/readme.md | 56 ++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 keyboards/jj40/keymaps/cockpit/readme.md diff --git a/keyboards/jj40/keymaps/cockpit/keymap.c b/keyboards/jj40/keymaps/cockpit/keymap.c index 8480f221eb..e8534b63d2 100644 --- a/keyboards/jj40/keymaps/cockpit/keymap.c +++ b/keyboards/jj40/keymaps/cockpit/keymap.c @@ -122,10 +122,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { * | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | * |------+------+------+------+------+-------------+------+------+------+------+------| * | | RGB | RGB | RGB | RGB | BL | BL | BL | | | | | - * | Caps | Togl | Hue+ | Sat+ | Brt+ | Togl |Breath| Brt+ | | | |VolUp | + * | Caps | Togl | Hue+ | Sat+ | Brt+ | Togl |Breath| Brt+ | | | | Vol+ | * |------+------+------+------+------+------|------+------+------+------+------+------| * | | | RGB | RGB | RGB | WWW | WWW | BL | | | | | - * |Shift | Term | Hue- | Sat- | Brt- | Back | Fwd | Brt- | | |PrScr |VolDn | + * |Shift | Term | Hue- | Sat- | Brt- | < | > | Brt- | | |PrScr | Vol- | * |------+------+------+------+------+------+------+------+------+------+------+------| * | |||||||| RGB | | | | | | | | | * | Ctrl |||Fn||| Mode | Alt | | Space |MPrev |MStop |MNext |MPlay | Lock | diff --git a/keyboards/jj40/keymaps/cockpit/readme.md b/keyboards/jj40/keymaps/cockpit/readme.md new file mode 100644 index 0000000000..37bd47b1d9 --- /dev/null +++ b/keyboards/jj40/keymaps/cockpit/readme.md @@ -0,0 +1,56 @@ +# Cockpit custom layout + +> This configuration is built around Lithuanian keyboard layout, but you can easily modify it to fit your needs + +## Layers + +### Default QWERTY + +| | | | | | | | | | | | | +| :-------: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :----: | :-------: | +|
Esc | Q
q | W
w | E
e | R
r | T
t | Y
y | U
u | I
i | O
o | P
p |
Bksp | +|
Tab | A
a | S
s | D
d | F
f | G
g | H
h | J
j | K
k | L
l | :
; | "
' | +|
Shift | Z
z | X
x | C
c | V
v | B
b | N
n | M
m | <
, | >
. | ?
/ |
Enter | +| Ctrl | Fn | GUI | Alt | Lower | Sp | ace | Raise | Left | Down | Up | Right | + +### Lower + +| | | | | | | | | | | | | +| :-------: | :----: | :----: | :----: | :-------: | :----: | :----: | :----: | :----: | :----: | :-----: | :------: | +| ~
\` | Ą
ą | Č
č | Ę
ę | Ė
ė | Į
į | Š
š | Ų
ų | Ū
ū | Ž
ž | \_
- |
Bksp | +|
Tab |
! |
@ |
# |
$ |
% |
^ |
& |
\* |
( |
) |
Del | +|
Shift |
= |
+ |
- |
\| | {
[ | }
] |
< |
> |
{ |
} |
Ins | +| Ctrl | | | Alt | **Lower** | Sp | ace | | Home | PgDn | PgUp | End | + +### Raise + +| | | | | | | | | | | | | +| :-------: | :----: | :-----: | :----: | :----: | :----: | :----: | :-------: | :-----: | :----: | :----: | :-------: | +| ~
\` | !
1 | @
2 | #
3 | $
4 | %
5 | ^
6 | &
7 | \*
8 | (
9 | )
0 |
Bksp | +|
Tab | $
4 | %
5 | ^
6 | | | | | | | | \|
\ | +|
Shift | &
7 | \*
8 | (
9 | )
0 | | | | <
, | >
. | ?
/ |
Enter | +| Ctrl | | | Alt | | Sp | ace | **Raise** | Left | Down | Up | Right | + +### Function + +* Caps does not work. Might be an issue with my laptop, not JJ40 specific. +* Backlight breathing does not work. +* **Term** button is bound to `Calculator`. I have set this button as a shortcut to open a terminal. +* **Lock** is a shortcut for `Alt + L` + +| | | | | | | | | | | | | +| :-------: | :---------: | :---------: | :---------: | :---------: | :--------: | :----------: | :--------: | :----: | :-----: | :-----: | :------: | +|
F1 |
F2 |
F3 |
F4 |
F5 |
F6 |
F7 |
F8 |
F9 |
F10 |
F11 |
F12 | +|
Caps | RGB
Togl | RGB
Hue+ | RGB
Sat+ | RGB
Brt+ | BL
Togl | BL
Breath | BL
Brt+ | | | |
Vol+ | +|
Shift |
Term | RGB
Hue- | RGB
Sat- | RGB
Brt- | WWW
< | WWW
> | BL
Brt- | | | PrScr |
Vol- | +| Ctrl | **Fn** | RGB
Mode | Alt | | Sp | ace | MPrev | MStop | MNext | MPlay | Lock | + +## Usage + +```bash +cd qmk_firmware +make jj40:cockpit +bootloadHID .build/jj40_cockpit.hex +``` + +_if you're getting permission errors use sudo_