summaryrefslogtreecommitdiffstats
path: root/keyboards/bastardkb/charybdis/readme.md
diff options
context:
space:
mode:
authorCharly Delay <0xcharly@users.noreply.github.com>2022-11-15 17:51:44 +0900
committerGitHub <noreply@github.com>2022-11-15 08:51:44 +0000
commit30b2dbe369b3a61d1d6681b0a689dbcdd41fc221 (patch)
treecddf4e7318c2b06d33d4b3750d2e4eb15f1d2333 /keyboards/bastardkb/charybdis/readme.md
parentee7426e7b19c25ddfc53d0b50db68a457d8f992b (diff)
Bastard Keyboards: upstream recent changes (#18903)
* bastardkb: cleanup blackpill configuration Fixes #17 * bastardkb: fix splinky configuration The pinout of the splinky changed between the last beta batch, and the production one. This commit updates the keyboard definition to support the new pinout by default, while offering backward compatibility. Define `SPLINKY_BETA_PINOUT` to build the firmware with pre-production pinout. Fixes #15 * bastardkb: add support for STeMCell * Update scylla/tbkmini/skeletyl outdated readmes * bastardkb/dilemma: enable circular scroll * bastardkb/dilemma: add initial version of the `via` keymap * bastardkb/dilemma/assembled: add new keyboard Fixes #20 * bastardkb/dilemma: remove elite-c * Initial support for the Dilemma 3x5+3 Assembled RGB * Address code review comments * Address more comments * Address review comments * Address more nits * bastardkb: split splinky-based keyboards to distinguish between Splinky v2 and v3 pinout
Diffstat (limited to 'keyboards/bastardkb/charybdis/readme.md')
-rw-r--r--keyboards/bastardkb/charybdis/readme.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/keyboards/bastardkb/charybdis/readme.md b/keyboards/bastardkb/charybdis/readme.md
index c112c1150e..dd0fca0015 100644
--- a/keyboards/bastardkb/charybdis/readme.md
+++ b/keyboards/bastardkb/charybdis/readme.md
@@ -21,6 +21,7 @@ Check out the [keyboard build guides](https://docs.bastardkb.com) for the Charyb
**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}
```
@@ -33,16 +34,16 @@ 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` |
+| 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` |
### 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` |
+| 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
@@ -164,17 +165,17 @@ To disable the custom keycodes, and reduce binary size, simply add a definition
### Configuration Syncing
-If you want/need to enable syncing of the charybdis config, such as to read the sniping or drag scroll modes on the other half (such as for displaying the status via rgb matrix, or added on screens, or what not), you can enabled this. To do so, add this to your `config.h`:
+If you want/need to enable syncing of the charybdis config, such as to read the sniping or drag scroll modes on the other half (such as for displaying the status via rgb matrix, or added on screens, or what not), you can enabled this. To do so, add this to your `config.h`:
```c
#define CHARYBDIS_CONFIG_SYNC
```
-Note that you will need to reflash both sides when enabling this.
+Note that you will need to reflash both sides when enabling this.
### Enable Large Mouse Reports
-By default, the X and Y motion for the pointing device/mouse reports is -127 to 127. You can definitely hit the limit for that with the sensors. You can enable support for -32767 to 32767 by adding this to your `config.h`:
+By default, the X and Y motion for the pointing device/mouse reports is -127 to 127. You can definitely hit the limit for that with the sensors. You can enable support for -32767 to 32767 by adding this to your `config.h`:
```c
#define MOUSE_EXTENDED_REPORT