summaryrefslogtreecommitdiffstats
path: root/keyboards/ferris
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2021-11-06 00:01:31 +0800
committerGitHub <noreply@github.com>2021-11-05 09:01:31 -0700
commitc1edd0e10e8dc87cfa24ad5e9d9219a7f9aab0c0 (patch)
tree8e66f612fe8236f9bfadb43638a1f826f68c3f58 /keyboards/ferris
parenta2d2c5bc694fa8627312d4f83d8e240133649c34 (diff)
Improve Sweep keyboard readme documentation (#15038)
Co-authored-by: filterpaper <filterpaper@localhost>
Diffstat (limited to 'keyboards/ferris')
-rw-r--r--keyboards/ferris/sweep/readme.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/keyboards/ferris/sweep/readme.md b/keyboards/ferris/sweep/readme.md
index f06cfbf266..a8cbf8fd80 100644
--- a/keyboards/ferris/sweep/readme.md
+++ b/keyboards/ferris/sweep/readme.md
@@ -5,20 +5,33 @@
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)
+## Keyboard Info
+
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
* Hardware Supported:
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout)
* Hardware Availability: @iamnotyourbroom in the 40% discord chat server may have some spares for you.
-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):
+Make example for this keyboard (after setting up your build environment):
+
+ make ferris/sweep:default
+
+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).
+
+## Setting Handedness
+
+Keyboard uses [handedness by EEPROM](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) as default. The make commands are:
make ferris/sweep:default:avrdude-split-left
make ferris/sweep:default:avrdude-split-right
-Subsequent make example for both sides:
+[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
- make ferris/sweep:default
+## Bootloader
-[Bootmagic lite](https://docs.qmk.fm/#/feature_bootmagic?id=bootmagic-lite) is also configured on the top right key for the right halve.
+Enter the bootloader in 3 ways:
+
+* **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.
+* **Physical reset button**: Briefly press the reset button soldered on the PCB.
+* **Keycode in layout**: Press the key mapped to `RESET` if it is configured.
-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).