summaryrefslogtreecommitdiffstats
path: root/users/drashna/split/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-12-29 20:17:34 -0800
committerGitHub <noreply@github.com>2021-12-29 20:17:34 -0800
commitc4551d7ef1ed2c1069f23cc8499b7c7fc30f3ecf (patch)
tree67dc381a45d59626132c4c59b71c4b36fa971f8b /users/drashna/split/readme.md
parent1a8a842cfb3e87a82afb57ba29ca59c5fa6fe97b (diff)
[Keymap] Reorganization, cleanup and readmes for drashna code (#15617)
Diffstat (limited to 'users/drashna/split/readme.md')
-rw-r--r--users/drashna/split/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/users/drashna/split/readme.md b/users/drashna/split/readme.md
new file mode 100644
index 0000000000..5dad340122
--- /dev/null
+++ b/users/drashna/split/readme.md
@@ -0,0 +1,29 @@
+# Custom Split Transport
+
+To disable the customized split transport, add `CUSTOM_SPLIT_TRANSPORT_SYNC = no` to your `rules.mk`.
+
+This syncs a number of additional settings, such as the keymap_config (magic settings), user eeprom configs, and misc firmware settings.
+
+Additionally, this supports a watchdog timer reset for the secondary split side.
+
+## User State Config
+
+The User states that it sync are:
+
+* Audio Enable status
+* Audio Clicky states
+* Unicode mode
+* Pointing Device tap toggle status
+* Swap Hands status
+* Host Driver status
+
+## Userspace Config
+
+The userspace config states that are synced are:
+
+* RGB layer indication
+* "is overwatch" status
+* nuke switch
+* Swapped numbers
+* RGB Matrix idle animation
+* Autocorrect enable status