diff options
Diffstat (limited to 'aktersnurra/ferris/readme.md')
| -rw-r--r-- | aktersnurra/ferris/readme.md | 33 |
1 files changed, 31 insertions, 2 deletions
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. |