Skip to content

Commit 87fb666

Browse files
Nathan0xcharly
authored andcommitted
bastardkbk/charybdis/readme.md: update build commands
Merge pull request #5 from Nathancooke7/update_charybdis_readme_v2_shield.
1 parent 73949de commit 87fb666

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

keyboards/bastardkb/charybdis/readme.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,32 @@ Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charyb
1818

1919
## Building the firmware
2020

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.**
2422

23+
The template is:
2524
```shell
26-
qmk compile -kb bastardkb/charybdis/4x6 -km default
25+
qmk compile -kb bastardkb/charybdis/{LAYOUT}/{VERSION}/elitec -km {KEYMAP}
2726
```
2827

29-
Check out the `via` layout if you're looking for VIA support:
28+
See below for populated commands per layout
3029

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.
3431

35-
### Charybdis (3x5)
32+
Check out the `via` layout if you're looking for VIA support.
3633

37-
The `default` keymap is inspired from the original [Dactyl Manuform](../../handwired/dactyl_manuform) layout.
34+
### Charybdis (4x6)
3835

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` |
4240

43-
Check out the `via` layout if you're looking for VIA support:
41+
### Charybdis (3x5)
4442

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` |
4847

4948
## Customizing the firmware
5049

@@ -73,7 +72,7 @@ Drag-scroll enables scrolling with the trackball. When drag-scroll is enabled, t
7372
7473
Call `charybdis_set_pointer_dragscroll_enabled(bool enable)` to enable/disable drag-scroll.
7574
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.
7776
7877
To invert the horizontal scrolling direction, define `CHARYBDIS_DRAGSCROLL_REVERSE_X`:
7978

0 commit comments

Comments
 (0)