diff options
Diffstat (limited to 'keyboards/bastardkb/charybdis/readme.md')
| -rw-r--r-- | keyboards/bastardkb/charybdis/readme.md | 19 |
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 |