diff options
| author | Gustaf Rydholm <gustaf.rydholm@gmail.com> | 2024-01-02 01:53:39 +0100 |
|---|---|---|
| committer | Gustaf Rydholm <gustaf.rydholm@gmail.com> | 2024-01-02 01:53:39 +0100 |
| commit | 97d26277e0cf8e19488000c40364d77992acd76a (patch) | |
| tree | 912bca78d0b583cbb6a922ab546aba1ad1089017 | |
| parent | 1e94ca773a5a007555f3c846d048bd08bbbf17aa (diff) | |
Update READMEs
| -rw-r--r-- | README.md | 34 | ||||
| -rw-r--r-- | aktersnurra/charybdis/README.md | 24 | ||||
| -rw-r--r-- | aktersnurra/ferris/readme.md | 33 |
3 files changed, 58 insertions, 33 deletions
@@ -1,32 +1,4 @@ -# Ferris Sweep Keymap Configuration +# Keymaps -My qmk colemak mod dh keymap configuration for the -[Ferris Sweep](https://github.com/davidphilipbarr/Sweep) keyboard. - -# Usage - -1. Clone the qmk firmware repository: - -``` -git clone git@github.com:qmk/qmk_firmware.git -``` - -2. Link this repository into the qmk ferris keyboards keymap configuration -directory: - -``` -cd keymaps -ln -sr aktersnurra ../qmk_firmware/keyboards/ferris/keymaps -``` - -3. Go to the `qmk_firmware` directory - -4. Compile the keymap for each half by running these commands: - -``` -make ferris/sweep:aktersnurra:dfu-split-left -make ferris/sweep:aktersnurra:dfu-split-right -``` - -NB connect the each half with the usb cable by holding down the upper left -(right) key to start the microcontroller in boot mode. +This repository contains my colemak mod dh keymaps for ferris and Charybdis nano +keyboards. 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. diff --git a/aktersnurra/ferris/readme.md b/aktersnurra/ferris/readme.md index ce2cf95..d4c2a06 100644 --- a/aktersnurra/ferris/readme.md +++ b/aktersnurra/ferris/readme.md @@ -1,3 +1,32 @@ -The Keymap +# Ferris Sweep Keymap Configuration -TBC with some nice images... +My qmk colemak mod dh keymap configuration for the +[Ferris Sweep](https://github.com/davidphilipbarr/Sweep) keyboard. + +# Usage + +1. Clone the qmk firmware repository: + +``` +git clone git@github.com:qmk/qmk_firmware.git +``` + +2. Link this repository into the qmk ferris keyboards keymap configuration +directory: + +``` +cd keymaps +ln -sr aktersnurra ../qmk_firmware/keyboards/ferris/keymaps +``` + +3. Go to the `qmk_firmware` directory + +4. Compile the keymap for each half by running these commands: + +``` +make ferris/sweep:aktersnurra:dfu-split-left +make ferris/sweep:aktersnurra:dfu-split-right +``` + +NB connect the each half with the usb cable by holding down the upper left +(right) key to start the microcontroller in boot mode. |