aboutsummaryrefslogtreecommitdiff
path: root/keyboards/rgbkb/sol/keymaps/xyverz/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/rgbkb/sol/keymaps/xyverz/readme.md')
-rw-r--r--keyboards/rgbkb/sol/keymaps/xyverz/readme.md132
1 files changed, 132 insertions, 0 deletions
diff --git a/keyboards/rgbkb/sol/keymaps/xyverz/readme.md b/keyboards/rgbkb/sol/keymaps/xyverz/readme.md
new file mode 100644
index 000000000..485426f8e
--- /dev/null
+++ b/keyboards/rgbkb/sol/keymaps/xyverz/readme.md
@@ -0,0 +1,132 @@
1# Xyverz's Sol Layout
2## Layout
3
4### Base modifier layout
5```
6 * ,------------------------------------------------. ,------------------------------------------------.
7 * | ESC | | | | | | - | | = | | | | | | \ |
8 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
9 * | Tab | | | | | | [ | | ] | | | | | | / |
10 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
11 * | Del | | | | | | | | | | | | | | |
12 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
13 * |Shift | | | | | | | | | | | | | |Shift |
14 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
15 * | Adj | Alt | ` | Left | Rght | Ctrl | Alt | | Alt | Ctrl | Up | Down | / | = | Adj |
16 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
17 * | BkSp | Win | | Enter| Space|
18 * `-------------' `-------------'
19```
20
21### Qwerty alphas
22```
23 * ,------------------------------------------------. ,------------------------------------------------.
24 * | | | | | | | | | | | | | | | |
25 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
26 * | | Q | W | E | R | T | | | | Y | U | I | O | P | |
27 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
28 * | | A | S | D | F | G | | | | H | J | K | L | ; | ' |
29 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
30 * | | Z | X | C | V | B | | | | N | M | , | . | / | |
31 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
32 * | | | | | | | | | | | | | | | |
33 * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
34 * | | | | | |
35 * `-------------' `-------------'
36```
37
38### Dvorak alphas
39```
40 * ,------------------------------------------------. ,------------------------------------------------.
41 * | | | | | | | | | | | | | | | |
42 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
43 * | | " | , | . | P | Y | | | | F | G | C | R | L | |
44 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
45 * | | A | O | E | U | I | | | | D | H | T | N | S | - |
46 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
47 * | | ; | Q | J | K | X | | | | B | M | W | V | Z | |
48 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
49 * | | | | | | | | | | | | | | | |
50 * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
51 * | | | | | |
52 * `-------------' `--------=----'
53```
54### Colemak alphas
55```
56 * ,------------------------------------------------. ,------------------------------------------------.
57 * | | | | | | | | | | | | | | | |
58 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
59 * | | Q | W | F | P | B | | | | J | L | U | Y | ; | |
60 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
61 * | | A | R | S | T | G | | | | K | N | E | I | O | ' |
62 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
63 * | | Z | X | C | D | V | | | | M | H | , | . | / | |
64 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
65 * | | | | | | | | | | | | | | | |
66 * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
67 * | | | | | |
68 * `-------------' `-------------'
69```
70
71### Adjust (ADJ)
72```
73 * ,------------------------------------------------. ,------------------------------------------------.
74 * | F11 | F1 | F2 | F3 | F4 | F5 | RESET| | | F6 | F7 | F8 | F9 | F10 | F12 |
75 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
76 * | | |QWERTY|DVORAK|COLEMK| | | | | | PrSc | ScLk | NmLk | | |
77 * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
78 * | | | Mute | Vol- | Vol+ | | | | |RGBTOG|RGBMOD| HUI | SAI | VAI | |
79 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
80 * | | | Prev | Play | Next | | | | | |RGBRMD| HUD | SAD | VAD | |
81 * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
82 * | | | | Home | End | | | | | | PgUp | PgDn | | | |
83 * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
84 * | Del | | | | Ins |
85 * `-------------' `-------------'
86```
87
88## Customize
89
90see `qmk_firmware/keyboards/sol/rev1/keymaps/default/rules.mk`
91
92```
93
94# Variables you can set for SOL
95
96BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
97MOUSEKEY_ENABLE = no # Mouse keys
98EXTRAKEY_ENABLE = yes # Audio control and System control
99CONSOLE_ENABLE = no # Console for debug
100COMMAND_ENABLE = ne # Commands for debug and configuration
101NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
102RGBLIGHT_ENABLE = yes # Enable global lighting effects. Do not enable with RGB Matrix
103LED_ANIMATIONS = yes # LED animations
104LED_MIRRORED = no # Mirror LEDs across halves (enable DIP 1 on slave, and DIP 2 and 3 on master)
105RGB_MATRIX_ENABLE = no # Enable per-key coordinate based RGB effects. Do not enable with RGBlight
106RGB_MATRIX_KEYPRESSES = no # Enable reactive per-key effects. Can be very laggy
107RGBLIGHT_FULL_POWER = no # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
108UNICODE_ENABLE = no # Unicode
109SWAP_HANDS_ENABLE = no # Enable one-hand typing
110ENCODER_ENABLE_CUSTOM = yes # Enable rotary encoder
111
112OLED_ENABLE = yes # OLED_ENABLE
113IOS_DEVICE_ENABLE = no # Limit max brightness to connect to IOS device (iPad,iPhone)
114
115
116```
117## Compile
118
119go to qmk top directory.
120```
121$ cd qmk_firmware
122```
123
124build
125```
126$ make sol:xyverz
127```
128
129After the initial flash with AVRdudess, you should be able to flash using this:
130```
131$ make sol:xyverz:flash
132```
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-16 00:03:54 +0000