diff options
| author | Gustaf Rydholm <gustaf.rydholm@gmail.com> | 2022-05-09 21:24:44 +0200 |
|---|---|---|
| committer | Gustaf Rydholm <gustaf.rydholm@gmail.com> | 2022-05-09 21:24:44 +0200 |
| commit | 4c61995d7a05f71e479401ed3d34db179537d679 (patch) | |
| tree | 12cd3d25a30f9675feb70928bdbcd4c911e392e2 /README.md | |
Initial commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbf1ea3 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Ferris Sweep Keymap Configuration + +My qmk keymap configuration for the Ferris 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. |