commit e31c8f30798a0e2042b15221268167b15f768b13 parent 58bb355bc5ffc08a8daa28f98cfb0870d48a5c34 Author: typable <contact@typable.dev> Date: Wed, 25 Oct 2023 10:52:02 +0200 Added install and flashing instructions Diffstat:
| M | README.md | | | 32 | +++++++++++++++++++++++++++++--- |
1 file changed, 29 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -1,3 +1,29 @@ -# claw-sweeper - -A QMK keymap layout for the Ferris Sweep split-keyboard +# claw-sweeper + +A QMK keymap layout for the Ferris Sweep split-keyboard + +## Installation + +``` +# install vial +git clone https://github.com/vial-kb/vial-qmk.git +cd vial-qmk + +make git-submodules + +# install claw-sweeper +cd keyboards/ferris/sweep/keymaps +git clone https://git.typable.dev/typable/claw-sweeper.git +``` + +## Flashing + +``` +# flash left half +qmk flash -kb ferris/sweep -km vial -e CONVERT_TO=helios -bl uf2-split-left + +# flash right half +qmk flash -kb ferris/sweep -km vial -e CONVERT_TO=helios -bl uf2-split-right +``` + +After each flash press the RESET button on the board for a few seconds.