bastardkbk/charybdis/readme.md: update build commands

Merge pull request qmk#5 from Nathancooke7/update_charybdis_readme_v2_shield.
0xcharly · Jul 2, 2022 · 245a66c · 245a66c
1 parent b4c38c8
commit 245a66c
Showing 1 changed file with 17 additions and 18 deletions.
diff --git a/keyboards/bastardkb/charybdis/readme.md b/keyboards/bastardkb/charybdis/readme.md
@@ -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
 
@@ -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`: