Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #5

Merged
merged 2 commits into from
Apr 7, 2022
Merged

update readme #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
234b597
update charybdis readme
Apr 6, 2022
94a0a35
fix drag-scroll section
Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 17 additions & 18 deletions keyboards/bastardkb/charybdis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,33 +18,32 @@ Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charyb

## Building the firmware

### Charybdis (4x6)

The `default` keymap is inspired from the original [Dactyl Manuform](../../handwired/dactyl_manuform) layout.
**You must specify the shield version when compiling/flashing the firmware.**

The template is:
```shell
qmk compile -kb bastardkb/charybdis/4x6 -km default
qmk compile -kb bastardkb/charybdis/{LAYOUT}/{VERSION}/elitec -km {KEYMAP}
```

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

```shell
qmk compile -kb bastardkb/charybdis/4x6 -km via
```
The `default` keymap is inspired from the original [Dactyl Manuform](../../handwired/dactyl_manuform) layout.

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

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

```shell
qmk compile -kb bastardkb/charybdis/3x5 -km default
```
| Shield Version | default | via |
|----------------|-----------------------------------------------------------------|-----------------------------------------------------------------|
| v1 | `qmk compile -kb bastardkb/charybdis/4x6/v1/elitec -km default` | `qmk compile -kb bastardkb/charybdis/4x6/v1/elitec -km via` |
| v2 | `qmk compile -kb bastardkb/charybdis/4x6/v2/elitec -km default` | `qmk compile -kb bastardkb/charybdis/4x6/v2/elitec -km via` |

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

```shell
qmk compile -kb bastardkb/charybdis/3x5 -km via
```
| Shield Version | default | via |
|----------------|-----------------------------------------------------------------|-----------------------------------------------------------------|
| v1 | `qmk compile -kb bastardkb/charybdis/3x5/v1/elitec -km default` | `qmk compile -kb bastardkb/charybdis/3x5/v1/elitec -km via` |
| v2 | `qmk compile -kb bastardkb/charybdis/3x5/v2/elitec -km default` | `qmk compile -kb bastardkb/charybdis/3x5/v2/elitec -km via` |

## Customizing the firmware

Expand Down Expand Up @@ -73,7 +72,7 @@ Drag-scroll enables scrolling with the trackball. When drag-scroll is enabled, t

Call `charybdis_set_pointer_dragscroll_enabled(bool enable)` to enable/disable drag-scroll.

`charybdis_get_pointer_dragscroll_enabled()` returns whether sniping mode is currently enabled.
`charybdis_get_pointer_dragscroll_enabled()` returns whether drag-scroll mode is currently enabled.

To invert the horizontal scrolling direction, define `CHARYBDIS_DRAGSCROLL_REVERSE_X`:

Expand Down