summaryrefslogtreecommitdiff
path: root/aktersnurra/charybdis
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2024-01-02 01:53:39 +0100
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2024-01-02 01:53:39 +0100
commit97d26277e0cf8e19488000c40364d77992acd76a (patch)
tree912bca78d0b583cbb6a922ab546aba1ad1089017 /aktersnurra/charybdis
parent1e94ca773a5a007555f3c846d048bd08bbbf17aa (diff)
Update READMEs
Diffstat (limited to 'aktersnurra/charybdis')
-rw-r--r--aktersnurra/charybdis/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/aktersnurra/charybdis/README.md b/aktersnurra/charybdis/README.md
new file mode 100644
index 0000000..78fa4bc
--- /dev/null
+++ b/aktersnurra/charybdis/README.md
@@ -0,0 +1,24 @@
+# Charybdis Nano
+
+## Requirements
+
+The basterdkb qmk [fork](https://github.com/Bastardkb/bastardkb-qmk) and this repo
+linked inside the keymap folder of the nano.
+
+## Flashing
+
+To flash the splinky:
+
+1. Disconnect the keyboard
+2. Reconnect one side
+3. Trigger boot mode
+4. Mount the controller
+5. Compile the keymap with:
+```sh
+qmk compile -c -kb bastardkb/charybdis/3x5/v2/splinky_3 -km aktersnurra
+```
+6. Copy over the new keymap to the controller:
+```sh
+doas cp bastardkb_charybdis_3x5_v2_splinky_3_aktersnurra.uf2 /mnt/usb
+```
+7. Repeat the step for the other side.