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.

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

BastardKB: upstream charybdis/4x6 #23811

Closed
wants to merge 16 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
update charybdis readme for removal of legacy variants
  • Loading branch information
burkfers committed May 28, 2024
commit 7fa53dbbd934ac98d08f4f2663bc5366fb7b39ea
34 changes: 20 additions & 14 deletions keyboards/bastardkb/charybdis/readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Charybdis (6x4, 5x3 "Nano")
# Charybdis (4x6, 3x6 "Mini", 3x5 "Nano")

An ergonomic keyboard with integrated trackball.

Engineered to be a full mouse replacement solution with high-quality, custom-developed components.

There are 6x4 and 5x3 "Nano" versions.
There are 4x6, 3x6 "Mini" and 3x5 "Nano" versions.

- Keyboard Maintainer: [Bastard Keyboards](https://github.com/Bastardkb)
- Hardware Supported: elite-C V4
- Hardware Supported: Splinky v3, Splinktegrated
- Hardware Availability: [Bastard Keyboards](https://bastardkb.com)

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
Expand All @@ -18,12 +18,10 @@ Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charyb

## Building the firmware

**You must specify the shield version when compiling/flashing the firmware.**

The template is:

```shell
qmk compile -kb bastardkb/charybdis/{LAYOUT}/{VERSION}/elitec -km {KEYMAP}
qmk compile -kb bastardkb/charybdis/{LAYOUT} -km {KEYMAP}
```

See below for populated commands per layout
Expand All @@ -34,17 +32,25 @@ Check out the `via` layout if you're looking for VIA support.

### Charybdis (4x6)

| 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` |
| default | via |
| ----------------------------------------------------- | ------------------------------------------------- |
| `qmk compile -kb bastardkb/charybdis/4x6 -km default` | `qmk compile -kb bastardkb/charybdis/4x6 -km via` |

### Charybdis (3x6)

| default | via |
| ----------------------------------------------------- | ------------------------------------------------- |
| `qmk compile -kb bastardkb/charybdis/3x6 -km default` | `qmk compile -kb bastardkb/charybdis/3x6 -km via` |

### Charybdis (3x5)

| 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` |
| default | via |
| ----------------------------------------------------- | ------------------------------------------------- |
| `qmk compile -kb bastardkb/charybdis/3x5 -km default` | `qmk compile -kb bastardkb/charybdis/3x5 -km via` |

### Legacy hardware

For older configurations, including `blackpill`, `v1` shield versions, `elitec` and `splinky_2` support, please see the archived tree at commit [`f0ffdc3b6d`](https://github.com/Bastardkb/bastardkb-qmk/tree/f0ffdc3b6d34b1d0e72474bc2d2296399871d5b9/keyboards/bastardkb/charybdis).

## Customizing the firmware

Expand Down