clean-up branch, update readme

7 files changed, 48 insertions, 203 deletions

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
deleted file mode 100644
index d74fb89..0000000
--- a/.github/workflows/build.yml
+++ /dev/null
@@ -1,5 +0,0 @@
-on: [push, pull_request, workflow_dispatch]
-
-jobs:
-  build:
-    uses: zmkfirmware/zmk/.github/workflows/build-user-config.yml@main
diff --git a/README.md b/README.md
index 4cd9d8d..96c816b 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,56 @@
+# eiga's zmk-config
+
 **You probably reached this page by watching one of my [Ergo Split Keyb Videos](https://www.youtube.com/playlist?list=PL1E2ddJCbc13DvCGYXX9jVVX1BqNGKE5D).**
 
 This repository hosts my zmk-configs as seen on the YouTube videos linked above.
 
 Additionally, this repository contains alternative configurations meant to be used with an extra controller acting as a dongle. Pease refer to the [Dongle Flashing](https://github.com/eigatech/zmk-config#dongle-flashing) chapter for instructions.
 
-### Corne
+> [!NOTE]  
+> The configurations above are meant to be used with builds that are identical to the ones featured in the videos, otherwise they should be used as reference only.
+
+## Table of contents
+
+- Branches
+    - [Corne](#corne)
+    - [Charybdis](#charybdis)
+        - [Module documentation](#module-documentation)
+    - [TOTEM](#totem)
+- [Dongle Flashing](#dongle-flashing)
+- [Shops and Useful links](#shops-and-other-useful-links)
+
+
+## Corne
 
 - [Corne](https://github.com/eigatech/zmk-config/tree/corne)
 - [Corne Dongle](https://github.com/eigatech/zmk-config/tree/corne-dongle)
 
-### Charybdis
+> [!NOTE]  
+> Shield is configured for an earlier revision of Pete Johanson's [Corne Ultralight PCB](https://github.com/petejohanson/crkbd/tree/board/corne-ultralight), with nice!view support.
+
+## Charybdis
 
 - [Charybdis](https://github.com/eigatech/zmk-config/tree/charybdis-3.5)
 - [Charybdis Dongle](https://github.com/eigatech/zmk-config/tree/charybdis-dongle)
 
-### TOTEM
+### Module documentation
+
+- Charybdis
+    - [ZMK PMW3610 Driver](https://github.com/inorichi/zmk-pmw3610-driver)
+- Charybdis Dongle
+    - [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
+    - [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener)
+    - [ZMK PMW3610 Driver](https://github.com/badjeff/zmk-pmw3610-driver)
+
+> [!NOTE]  
+> Charybdis uses Inorichi's PMW3610 driver, while Charybdis Dongle leverages multiple modules written by badjeff.
+
+## TOTEM
 
 - [TOTEM](https://github.com/eigatech/zmk-config/tree/totem)
 - [TOTEM Dongle](https://github.com/eigatech/zmk-config/tree/totem-dongle)
 
-### Dongle Flashing
+## Dongle Flashing
 
 Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed [case](https://www.printables.com/model/522586-seeed-xiao-ble-case).
 
@@ -30,16 +61,19 @@ Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed
 5. Flash the first half with the `left` or `right` files.
 6. Repeat steps 4 and 5 for the other half.
 
-*When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!*
-
-### Notes
-
-The configurations above are meant to be used with builds that are identical to the ones featured in the videos, otherwise they should be used as reference only.
-
-### ZMK Modules used
+> [!WARNING]  
+> When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!
 
-[zmk-split-peripheral-input-relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
+## Shops and other useful links
 
-[zmk-input-behavior-listener](https://github.com/badjeff/zmk-input-behavior-listener)
+Kits, Prebuilts, Parts:
+- [kbd.news](https://kbd.news/vendors) - mechanical keyboard vendors list
+- [42keebs.eu](http://42keebs.eu/) - diy kits, including Corne, switches and other parts
+- [keeb.supply](https://keeb.supply/) - diy kits and prebuilts, including TOTEM, tools and other parts
+- [splitkb.com](https://splitkb.com/) - diy kits, including Corne, switches, tools and other parts
+- [bastardkb.com](https://bastardkb.com/) - diy kits and prebuilts, including Charybdis (wired only w/ qmk)
+- [typeractive.xyz](https://typeractive.xyz/) - diy kits and prebuilts, including Corne w/ nice!views, switches, tools and other parts
 
-[zmk-pmw3610-driver](https://github.com/badjeff/zmk-pmw3610-driver)
+Documentation and guides:
+- [ZMK Firmware Documentation](https://zmk.dev/docs)
+- [Eren's Wireless Charybdis Mini Guide](https://github.com/erenatas/charybdis-wireless-3x6)
\ No newline at end of file
diff --git a/build.yaml b/build.yaml
deleted file mode 100644
index 228498f..0000000
--- a/build.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-# This file generates the GitHub Actions matrix
-# For simple board + shield combinations, add them
-# to the top level board and shield arrays, for more
-# control, add individual board + shield combinations to
-# the `include` property, e.g:
-#
-# board: [ "nice_nano_v2" ]
-# shield: [ "corne_left", "corne_right" ]
-# include:
-#   - board: bdn9_rev2
-#   - board: nice_nano_v2
-#     shield: reviung41
-#
----
-include:
-  - board: nice_nano_v2
-    shield: corne_left nice_view_adapter nice_view
-  - board: nice_nano_v2
-    shield: corne_right nice_view_adapter nice_view
diff --git a/config/corne.conf b/config/corne.conf
deleted file mode 100644
index 4f7eda5..0000000
--- a/config/corne.conf
+++ /dev/null
@@ -1,12 +0,0 @@
-# Uncomment the following lines to enable the Corne RGB Underglow
-# CONFIG_ZMK_RGB_UNDERGLOW=y
-# CONFIG_WS2812_STRIP=y
-
-# Uncomment the following line to enable the Corne OLED Display
-CONFIG_ZMK_DISPLAY=y
-CONFIG_ZMK_EXT_POWER=y
-CONFIG_ZMK_SLEEP=y
-CONFIG_ZMK_IDLE_SLEEP_TIMEOUT=3600000
-CONFIG_ZMK_WIDGET_WPM_STATUS=n
-CONFIG_ZMK_BATTERY_REPORT_INTERVAL=600
-CONFIG_ZMK_WIDGET_BATTERY_STATUS_SHOW_PERCENTAGE=y
diff --git a/config/corne.keymap b/config/corne.keymap
deleted file mode 100644
index 08080e4..0000000
--- a/config/corne.keymap
+++ /dev/null
@@ -1,86 +0,0 @@
-/*
- * Copyright (c) 2020 The ZMK Contributors
- *
- * SPDX-License-Identifier: MIT
- */
-
-#include <behaviors.dtsi>
-#include <dt-bindings/zmk/bt.h>
-#include <dt-bindings/zmk/keys.h>
-#include <dt-bindings/zmk/outputs.h>
-
-/ {
-    keymap {
-        compatible = "zmk,keymap";
-
-        Base {
-            // -----------------------------------------------------------------------------------------
-            // |  TAB |  Q  |  W  |  E  |  R  |  T  |   |  Y  |  U   |  I  |  O  |  P  | BKSP |
-            // | CTRL |  A  |  S  |  D  |  F  |  G  |   |  H  |  J   |  K  |  L  |  ;  |  '   |
-            // | SHFT |  Z  |  X  |  C  |  V  |  B  |   |  N  |  M   |  ,  |  .  |  /  | ESC  |
-            //                    | GUI | LWR | SPC |   | ENT | RSE  | ALT |
-
-            label = "Base";
-            bindings = <
-&kp ESCAPE  &kp Q  &kp W  &kp E      &kp R  &kp T        &kp Y    &kp U  &kp I      &kp O    &kp P     &kp BSPC
-&kp TAB     &kp A  &kp S  &kp D      &kp F  &kp G        &kp H    &kp J  &kp K      &kp L    &kp SEMI  &kp APOS
-&kp LSHFT   &kp Z  &kp X  &kp C      &kp V  &kp B        &kp N    &kp M  &kp COMMA  &kp DOT  &kp FSLH  &kp RSHIFT
-                          &kp LCTRL  &mo 1  &kp SPACE    &kp RET  &mo 2  &kp RALT
-            >;
-        };
-
-        Lower {
-            // -----------------------------------------------------------------------------------------
-            // |  TAB |  1  |  2  |  3  |  4  |  5  |   |  6  |  7  |  8  |  9  |  0  | BKSP |
-            // | BTCLR| BT1 | BT2 | BT3 | BT4 | BT5 |   | LFT | DWN |  UP | RGT |     |      |
-            // | SHFT |     |     |     |     |     |   |     |     |     |     |     |      |
-            //                    | GUI |     | SPC |   | ENT |     | ALT |
-
-            label = "Lower";
-            bindings = <
-&trans        &trans    &kp UP    &trans     &trans     &trans       &kp N7   &kp N8     &kp N9    &kp N0   &kp HOME  &kp F1
-&trans        &kp LEFT  &kp DOWN  &kp RIGHT  &trans     &trans       &kp N4   &kp N5     &kp N6    &trans   &trans    &kp F10
-&kp LEFT_ALT  &trans    &trans    &trans     &kp MINUS  &kp PLUS     &kp N1   &kp N2     &kp N3    &kp DOT  &trans    &kp F20
-                                  &kp LGUI   &trans     &kp SPACE    &kp RET  &kp RCTRL  &kp RALT
-            >;
-        };
-
-        Raise {
-            // -----------------------------------------------------------------------------------------
-            // |  TAB |  !  |  @  |  #  |  $  |  %  |   |  ^  |  &  |  *  |  (  |  )  | BKSP |
-            // | CTRL |     |     |     |     |     |   |  -  |  =  |  [  |  ]  |  \  |  `   |
-            // | SHFT |     |     |     |     |     |   |  _  |  +  |  {  |  }  | "|" |  ~   |
-            //                    | GUI |     | SPC |   | ENT |     | ALT |
-
-            label = "Raise";
-            bindings = <
-&trans  &kp EXCL      &kp AT      &kp HASH    &kp DLLR      &kp PRCNT    &kp CARET  &kp AMPS   &kp KP_MULTIPLY  &kp LPAR  &kp RPAR  &kp DEL
-&trans  &bt BT_CLR    &bt BT_PRV  &bt BT_NXT  &trans        &to 3        &kp UNDER  &kp EQUAL  &kp LBKT         &kp RBKT  &kp BSLH  &kp GRAVE
-&trans  &out OUT_TOG  &trans      &trans      &trans        &trans       &kp MINUS  &kp PLUS   &kp LBRC         &kp RBRC  &kp PIPE  &kp TILDE
-                                  &kp LGUI    &kp LEFT_ALT  &kp SPACE    &kp RET    &trans     &kp RALT
-            >;
-        };
-
-        Game {
-            label = "Game";
-            bindings = <
-&trans  &trans  &trans  &trans  &trans        &trans    &trans  &trans         &trans  &trans  &trans  &trans
-&trans  &trans  &trans  &trans  &trans        &sl 4     &trans  &trans         &trans  &trans  &trans  &trans
-&trans  &trans  &trans  &trans  &trans        &trans    &trans  &trans         &trans  &trans  &trans  &to 0
-                        &trans  &kp LEFT_ALT  &trans    &trans  &kp RIGHT_WIN  &trans
-            >;
-        };
-
-        Game_++ {
-            label = "Game ++";
-            bindings = <
-&kp N0   &kp NUMBER_1  &kp NUMBER_2  &kp NUMBER_3  &kp NUMBER_4  &kp NUMBER_5    &kp LC(RA(Y))  &kp LC(RA(U))  &kp LC(RA(I))  &kp LC(RA(H))  &kp LC(RA(J))  &kp LC(RA(DEL))
-&to 3    &kp L         &kp O         &kp Y         &kp K         &kp G           &kp F5         &trans         &trans         &trans         &trans         &kp LA(F4)
-&kp F10  &none         &to 0         &none         &kp NUMBER_6  &kp NUMBER_7    &trans         &trans         &trans         &trans         &trans         &to 0
-                                     &kp J         &kp I         &kp M           &trans         &trans         &trans
-            >;
-        };
-    };
-};
-
-&nice_view_spi { cs-gpios = <&pro_micro 0 GPIO_ACTIVE_HIGH>; };
diff --git a/config/info.json b/config/info.json
deleted file mode 100644
index 8e60647..0000000
--- a/config/info.json
+++ /dev/null
@@ -1,56 +0,0 @@
-{
-  "id": "corne",
-  "name": "corne",
-  "layouts": {
-    "LAYOUT": {
-      "layout": [
-        { "label":    "Tab", "row": 0, "col":  0, "x":    0, "y":  0.5 },
-        { "label":      "Q", "row": 0, "col":  1, "x":    1, "y":  0.5 },
-        { "label":      "W", "row": 0, "col":  2, "x":    2, "y":  0.2 },
-        { "label":      "E", "row": 0, "col":  3, "x":    3, "y":    0 },
-        { "label":      "R", "row": 0, "col":  4, "x":    4, "y": 0.25 },
-        { "label":      "T", "row": 0, "col":  5, "x":    5, "y": 0.25 },
-        { "label":      "Y", "row": 0, "col":  7, "x":    9, "y": 0.25 },
-        { "label":      "U", "row": 0, "col":  8, "x":   10, "y": 0.25 },
-        { "label":      "I", "row": 0, "col":  9, "x":   11, "y":    0 },
-        { "label":      "O", "row": 0, "col": 10, "x":   12, "y":  0.2 },
-        { "label":      "P", "row": 0, "col": 11, "x":   13, "y":  0.5 },
-        { "label":   "BSPC", "row": 0, "col": 12, "x":   14, "y":  0.5 },
-
-        { "label":   "Ctrl", "row": 1, "col":  0, "x":    0, "y":  1.5 },
-        { "label":      "A", "row": 1, "col":  1, "x":    1, "y":  1.5 },
-        { "label":      "S", "row": 1, "col":  2, "x":    2, "y":  1.2 },
-        { "label":      "D", "row": 1, "col":  3, "x":    3, "y":    1 },
-        { "label":      "F", "row": 1, "col":  4, "x":    4, "y": 1.25 },
-        { "label":      "G", "row": 1, "col":  5, "x":    5, "y": 1.25 },
-        { "label":      "H", "row": 1, "col":  7, "x":    9, "y": 1.25 },
-        { "label":      "J", "row": 1, "col":  8, "x":   10, "y": 1.25 },
-        { "label":      "K", "row": 1, "col":  9, "x":   11, "y":    1 },
-        { "label":      "L", "row": 1, "col": 10, "x":   12, "y":  1.2 },
-        { "label":      ";", "row": 1, "col": 11, "x":   13, "y":  1.5 },
-        { "label":      "'", "row": 1, "col": 12, "x":   14, "y":  1.5 },
-
-        { "label": "LShift", "row": 2, "col":  0, "x":    0, "y":  2.5 },
-        { "label":      "Z", "row": 2, "col":  1, "x":    1, "y":  2.5 },
-        { "label":      "X", "row": 2, "col":  2, "x":    2, "y":  2.2 },
-        { "label":      "C", "row": 2, "col":  3, "x":    3, "y":    2 },
-        { "label":      "V", "row": 2, "col":  4, "x":    4, "y": 2.25 },
-        { "label":      "B", "row": 2, "col":  5, "x":    5, "y": 2.25 },
-        { "label":      "N", "row": 2, "col":  7, "x":    9, "y": 2.25 },
-        { "label":      "M", "row": 2, "col":  8, "x":   10, "y": 2.25 },
-        { "label":      ",", "row": 2, "col":  9, "x":   11, "y":    2 },
-        { "label":      ".", "row": 2, "col": 10, "x":   12, "y":  2.2 },
-        { "label":      "/", "row": 2, "col": 11, "x":   13, "y":  2.5 },
-        { "label":    "Esc", "row": 2, "col": 12, "x":   14, "y":  2.5 },
-
-        { "label":    "GUI", "row": 3, "col":  3, "x":  3.5, "y": 3.25 },
-        { "label":    "LWR", "row": 3, "col":  4, "x":  4.5, "y": 3.25, "r":  13, "ry": 4.25 },
-        { "label":    "SPC", "row": 3, "col":  5, "x":  5.5, "y": 3.05, "r":  26, "ry":  4.6, "h": 1.5 },
-        { "label":    "ENT", "row": 3, "col":  7, "x":  8.5, "y": 3.05, "r": -26, "ry":  4.6, "h": 1.5, "rx":  9.5 },
-        { "label":    "RSE", "row": 3, "col":  8, "x":  9.5, "y": 3.25, "r": -13, "ry": 4.25,           "rx": 10.5 },
-        { "label":    "ALT", "row": 3, "col":  9, "x": 10.5, "y": 3.25 }
-      ]
-    }
-  },
-  "sensors": []
-}
\ No newline at end of file
diff --git a/config/west.yml b/config/west.yml
deleted file mode 100644
index 379d291..0000000
--- a/config/west.yml
+++ /dev/null
@@ -1,11 +0,0 @@
-manifest:
-  remotes:
-    - name: zmkfirmware
-      url-base: https://github.com/zmkfirmware
-  projects:
-    - name: zmk
-      remote: zmkfirmware
-      revision: main
-      import: app/west.yml
-  self:
-    path: config