Merge branch 'main'

egll-tech · Dec 26, 2023 · 9a082ce · 9a082ce
2 parents 13f52b6 + 2c3c8c9
commit 9a082ce
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 34 deletions.
diff --git a/build.yaml b/build.yaml
@@ -1,3 +1,8 @@
+# For the standard ErgoDox Wireless dongle setup with the latest Raytac "green"
+# dongle, you do not need to modify this file. If you are using a different
+# dongle such as the older Raytac "blue" dongle, you will need to modify
+# "board". For a dongleless setup, you will need to modify both "board" and
+# "shield". Please see "readme.md" for more details.
 include:
-  - board: raytac_mdbt50q_rx
+  - board: raytac_mdbt50q_rx_green
     shield: slicemk_ergodox_dongle
diff --git a/config/slicemk_ergodox.keymap b/config/slicemk_ergodox.keymap
@@ -16,37 +16,39 @@
 				&sl 2    &kp Z        &kp X        &kp C        &kp V        &kp B        &kp M_VOLD &none      &kp N        &kp M        &kp CMMA     &kp DOT      &kp FSLH      &sl 2
 				&kp CLCK &kp LGUI     &kp LALT     &kp LARW     &kp UARW                                                     &kp DARW     &kp RARW     &kp RALT     &kp K_APP     &to 3
 				                                                             &kp DEL      &kp HOME   &kp END    &kp INS
-				                                                &kp SPC      &kp LCTL     &kp PGUP   &kp PGDN   &kp LSFT     &kp RET
-				                                                                          &kp LGUI   &sl 1
+				                                                &kp LSFT     &kp LCTL     &kp PGUP   &kp PGDN   &kp SPC      &kp LGUI
+				                                                                          &kp RET    &mo 1
 			>;
 		};
 
 		layer_1 {
 			bindings = <
 				&bootloader
-				&bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &none &none &to 0 &none &none   &none   &none   &none   &bootloader
-				&bt BT_CLR   &kp F1       &kp F2       &kp F3       &kp F4       &none &none &none &none &kp F13 &kp F14 &kp F15 &kp F16 &out OUT_USB
-				&none        &kp F5       &kp F6       &kp F7       &kp F8       &none             &none &kp F17 &kp F18 &kp F19 &kp F20 &out OUT_BLE
-				&none        &kp F9       &kp F10      &kp F11      &kp F12      &none &none &none &none &kp F21 &kp F22 &kp F23 &kp F24 &out OUT_TOG
+				&bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4 &none &none &none &none &none   &none   &none   &none   &bootloader
+				&out OUT_USB &kp F1       &kp F2       &kp F3       &kp F4       &none &none &none &none &kp F13 &kp F14 &kp F15 &kp F16 &none
+				&out OUT_BLE &kp F5       &kp F6       &kp F7       &kp F8       &none             &none &kp F17 &kp F18 &kp F19 &kp F20 &none
+				&none        &kp F9       &kp F10      &kp F11      &kp F12      &none &none &none &none &kp F21 &kp F22 &kp F23 &kp F24 &bt BT_CLR
 				&none        &none        &none        &none        &none                                &none   &none   &none   &none   &none
 				                                                                 &none &none &none &none
 				                                                    &none        &none &none &none &none &none
-				                                                                       &none &to 0
+				                                                                       &none &none
 			>;
 		};
+
 		layer_2 {
 			bindings = <
 				&bootloader
-				&none &none &none &none    &none            &none             &none          &to 0            &none &none          &none           &none &none &none
-				&none &none &none &none    &none            &none             &none          &kp C_PLAY_PAUSE &none &none          &none           &none &none &none
+				&none &none &none &none    &none            &none             &none          &none            &none &none          &none           &none &none &none
+				&none &none &none &none    &none            &none             &kp C_POWER    &kp C_PLAY_PAUSE &none &none          &none           &none &none &none
 				&none &none &none &kp PLUS &kp EQUAL        &none                                             &none &kp MINUS      &kp UNDERSCORE  &none &none &none
-				&to 0 &none &none &kp LBKT &kp RBKT         &none             &kp C_PREVIOUS &kp C_NEXT       &none &kp LEFT_BRACE &kp RIGHT_BRACE &none &none &to 0
+				&none &none &none &kp LBKT &kp RBKT         &none             &kp C_PREVIOUS &kp C_NEXT       &none &kp LEFT_BRACE &kp RIGHT_BRACE &none &none &none
 				&none &none &none &none    &none                                                                    &none          &none           &none &none &none
 				                                            &none             &none          &none            &none
 				                           &kp SINGLE_QUOTE &kp DOUBLE_QUOTES &none          &none            &none &none
 				                                                              &none          &none
 			>;
 		};
+
 		layer_3 {
 			bindings = <
 				&bootloader

diff --git a/config/slicemk_ergodox_dongle.conf b/config/slicemk_ergodox_dongle.conf
@@ -0,0 +1,3 @@
+# If you are using a dongle, custom ZMK configuration options should go in this
+# file. If you are not using a dongle (using the left as central), this file is
+# ignored.
diff --git a/config/slicemk_ergodox_leftcentral.conf b/config/slicemk_ergodox_leftcentral.conf
@@ -0,0 +1,3 @@
+# If you are not using a dongle (using the left as central), custom ZMK
+# configuration options should go in this file. If you are using a dongle, this
+# file is ignored.
diff --git a/readme.md b/readme.md
@@ -7,52 +7,62 @@ options for customization.
 If you have questions, feel free to join the [SliceMK
 Discord](https://discord.gg/FQvyd7BAaA).
 
-# Instructions
+# Getting Started
 
 - Fork this repository on GitHub.
 - Modify the `board` and `shield` values in `build.yaml` to match the ZMK build
   target based on your hardware (see below).
-- If you have a dongleless setup, delete `config/slicemk_ergodox_dongle.conf`
-  and create an empty `config/slicemk_ergodox_leftcentral.conf` in its place.
+
+# Customization
+
+- To modify your keymap, edit `config/slicemk_ergodox.keymap`.
+- If you are using a dongle, add custom ZMK configuration options to
+  `config/slicemk_ergodox_dongle.conf`. If you are not using a dongle, custom
+  options should instead go in `config/slicemk_ergodox_leftcentral.conf`.
+- To use with a custom ZMK fork, edit `config/west.yml`.
 
 # Board/Shield
 
 If you are not sure which dongle or PCB version you have, please put your
 dongle/PCB into bootloader mode and check the "Model" value within the
 `INFO_UF2.TXT` file.
 
+GitHub Actions will only build the firmware for your central. Please download
+the firmware for your peripheral(s)
+[here](https://www.slicemk.com/pages/ergodox-wireless-peripheral).
+
 Here are some of the common dongle options:
 
 - **Raytac MDBT50Q-RX Green**
-	- Board `raytac_mdbt50q_rx_green`
-	- Shield `slicemk_ergodox_dongle`
+  - Board `raytac_mdbt50q_rx_green`
+  - Shield `slicemk_ergodox_dongle`
 - **Raytac MDBT50Q-RX** (if it does not say "green")
-	- Board `raytac_mdbt50q_rx`
-	- Shield `slicemk_ergodox_dongle`
+  - Board `raytac_mdbt50q_rx`
+  - Shield `slicemk_ergodox_dongle`
 - **Nordic nRF52840 Dongle**
-	- Board `nordic_nrf52840_dongle_slicemk`
-	- Shield `slicemk_ergodox_dongle`
+  - Board `nordic_nrf52840_dongle_slicemk`
+  - Shield `slicemk_ergodox_dongle`
 - **SliceMK USB C Dongle MDBT50Q Blue**
-	- Board `slicemk_usbc_mdbt50q_blue`
-	- Shield `slicemk_ergodox_dongle`
+  - Board `slicemk_usbc_mdbt50q_blue`
+  - Shield `slicemk_ergodox_dongle`
 
 Here are some of the common dongleless options:
 
 - **SliceMK ErgoDox Wireless 202104**
-	- Board `slicemk_ergodox_202104`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202104`
+  - Shield `slicemk_ergodox_leftcentral`
 - **SliceMK ErgoDox Wireless 202108 Blue**
-	- Board `slicemk_ergodox_202108_blue_left`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202108_blue_left`
+  - Shield `slicemk_ergodox_leftcentral`
 - **SliceMK ErgoDox Wireless 202108 Green**
-	- Board `slicemk_ergodox_202108_green_left`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202108_green_left`
+  - Shield `slicemk_ergodox_leftcentral`
 - **SliceMK ErgoDox Wireless 202109**
-	- Board `slicemk_ergodox_202109`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202109`
+  - Shield `slicemk_ergodox_leftcentral`
 - **SliceMK ErgoDox Wireless 202205 Green**
-	- Board `slicemk_ergodox_202205_green_left`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202205_green_left`
+  - Shield `slicemk_ergodox_leftcentral`
 - **SliceMK ErgoDox Wireless 202207 Green**
-	- Board `slicemk_ergodox_202207_green_left`
-	- Shield `slicemk_ergodox_leftcentral`
+  - Board `slicemk_ergodox_202207_green_left`
+  - Shield `slicemk_ergodox_leftcentral`