diff options
author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2021-11-06 00:01:31 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-05 09:01:31 -0700 |
commit | c1edd0e10e8dc87cfa24ad5e9d9219a7f9aab0c0 (patch) | |
tree | 8e66f612fe8236f9bfadb43638a1f826f68c3f58 | |
parent | a2d2c5bc694fa8627312d4f83d8e240133649c34 (diff) | |
download | qmk_firmware-c1edd0e10e8dc87cfa24ad5e9d9219a7f9aab0c0.tar.gz qmk_firmware-c1edd0e10e8dc87cfa24ad5e9d9219a7f9aab0c0.zip |
Improve Sweep keyboard readme documentation (#15038)
Co-authored-by: filterpaper <filterpaper@localhost>
-rw-r--r-- | keyboards/ferris/sweep/readme.md | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/keyboards/ferris/sweep/readme.md b/keyboards/ferris/sweep/readme.md index f06cfbf26..a8cbf8fd8 100644 --- a/keyboards/ferris/sweep/readme.md +++ b/keyboards/ferris/sweep/readme.md | |||
@@ -5,20 +5,33 @@ | |||
5 | 5 | ||
6 | A version of the Ferris keyboard that uses a daughterboard, designed by the fantastic @davidphilipbarr with some input from @pierrechevalier83 for the copper pad. All PCB files are available on the [project's github page](https://github.com/davidphilipbarr/Sweep) | 6 | A version of the Ferris keyboard that uses a daughterboard, designed by the fantastic @davidphilipbarr with some input from @pierrechevalier83 for the copper pad. All PCB files are available on the [project's github page](https://github.com/davidphilipbarr/Sweep) |
7 | 7 | ||
8 | ## Keyboard Info | ||
9 | |||
8 | * Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | 10 | * Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) |
9 | * Hardware Supported: | 11 | * Hardware Supported: |
10 | * Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout) | 12 | * Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout) |
11 | * Hardware Availability: @iamnotyourbroom in the 40% discord chat server may have some spares for you. | 13 | * Hardware Availability: @iamnotyourbroom in the 40% discord chat server may have some spares for you. |
12 | 14 | ||
13 | Initial [EE_HANDS](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) make examples for this keyboard (after setting up your build environment): | 15 | Make example for this keyboard (after setting up your build environment): |
16 | |||
17 | make ferris/sweep:default | ||
18 | |||
19 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||
20 | |||
21 | ## Setting Handedness | ||
22 | |||
23 | Keyboard uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default. The make commands are: | ||
14 | 24 | ||
15 | make ferris/sweep:default:avrdude-split-left | 25 | make ferris/sweep:default:avrdude-split-left |
16 | make ferris/sweep:default:avrdude-split-right | 26 | make ferris/sweep:default:avrdude-split-right |
17 | 27 | ||
18 | Subsequent make example for both sides: | 28 | [QMK Toolbox](http://qmk.fm/toolbox) can also be used to set EEPROM handedness. Place the controller in bootloader mode and select menu option Tools -> EEPROM -> Set Left/Right Hand |
19 | 29 | ||
20 | make ferris/sweep:default | 30 | ## Bootloader |
21 | 31 | ||
22 | [Bootmagic lite](https://docs.qmk.fm/#/feature_bootmagic?id=bootmagic-lite) is also configured on the top right key for the right halve. | 32 | Enter the bootloader in 3 ways: |
33 | |||
34 | * **Bootmagic reset**: Hold down the top left key on the left half (or the top right right key on the right half) and plug in the controller on that side. | ||
35 | * **Physical reset button**: Briefly press the reset button soldered on the PCB. | ||
36 | * **Keycode in layout**: Press the key mapped to `RESET` if it is configured. | ||
23 | 37 | ||
24 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||