@@ -18,33 +18,32 @@ Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charyb
18
18
19
19
## Building the firmware
20
20
21
- ### Charybdis (4x6)
22
-
23
- The ` default ` keymap is inspired from the original [ Dactyl Manuform] ( ../../handwired/dactyl_manuform ) layout.
21
+ ** You must specify the shield version when compiling/flashing the firmware.**
24
22
23
+ The template is:
25
24
``` shell
26
- qmk compile -kb bastardkb/charybdis/4x6 -km default
25
+ qmk compile -kb bastardkb/charybdis/{LAYOUT}/{VERSION}/elitec -km {KEYMAP}
27
26
```
28
27
29
- Check out the ` via ` layout if you're looking for VIA support:
28
+ See below for populated commands per layout
30
29
31
- ``` shell
32
- qmk compile -kb bastardkb/charybdis/4x6 -km via
33
- ```
30
+ The ` default ` keymap is inspired from the original [ Dactyl Manuform] ( ../../handwired/dactyl_manuform ) layout.
34
31
35
- ### Charybdis (3x5)
32
+ Check out the ` via ` layout if you're looking for VIA support.
36
33
37
- The ` default ` keymap is inspired from the original [ Dactyl Manuform ] ( ../../handwired/dactyl_manuform ) layout.
34
+ ### Charybdis (4x6)
38
35
39
- ``` shell
40
- qmk compile -kb bastardkb/charybdis/3x5 -km default
41
- ```
36
+ | Shield Version | default | via |
37
+ | ----------------| -----------------------------------------------------------------| -----------------------------------------------------------------|
38
+ | v1 | ` qmk compile -kb bastardkb/charybdis/4x6/v1/elitec -km default ` | ` qmk compile -kb bastardkb/charybdis/4x6/v1/elitec -km via ` |
39
+ | v2 | ` qmk compile -kb bastardkb/charybdis/4x6/v2/elitec -km default ` | ` qmk compile -kb bastardkb/charybdis/4x6/v2/elitec -km via ` |
42
40
43
- Check out the ` via ` layout if you're looking for VIA support:
41
+ ### Charybdis (3x5)
44
42
45
- ``` shell
46
- qmk compile -kb bastardkb/charybdis/3x5 -km via
47
- ```
43
+ | Shield Version | default | via |
44
+ | ----------------| -----------------------------------------------------------------| -----------------------------------------------------------------|
45
+ | v1 | ` qmk compile -kb bastardkb/charybdis/3x5/v1/elitec -km default ` | ` qmk compile -kb bastardkb/charybdis/3x5/v1/elitec -km via ` |
46
+ | v2 | ` qmk compile -kb bastardkb/charybdis/3x5/v2/elitec -km default ` | ` qmk compile -kb bastardkb/charybdis/3x5/v2/elitec -km via ` |
48
47
49
48
## Customizing the firmware
50
49
@@ -73,7 +72,7 @@ Drag-scroll enables scrolling with the trackball. When drag-scroll is enabled, t
73
72
74
73
Call `charybdis_set_pointer_dragscroll_enabled(bool enable)` to enable/disable drag-scroll.
75
74
76
- `charybdis_get_pointer_dragscroll_enabled()` returns whether sniping mode is currently enabled.
75
+ `charybdis_get_pointer_dragscroll_enabled()` returns whether drag-scroll mode is currently enabled.
77
76
78
77
To invert the horizontal scrolling direction, define `CHARYBDIS_DRAGSCROLL_REVERSE_X`:
79
78
0 commit comments