Skip to content

Commit

Permalink
Re-arrange readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhanukamax committed Dec 24, 2021
1 parent 5085c00 commit f6e81bc
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,15 @@ Sweep is a version of the more fabulous [Ferris](https://github.com/pierrecheval
| Sweep Half Swept ||||| | | |||
| Sweep Compact Low || || | || || |

*<sup>[1]</sup> It simply means that it supports the nice!nano. An on/off switch is recommended for bluetooth*
*<sup>[2]</sup> Choc spaced boards have the switches in a tighter grid. This provides a better final look but is only compatible with some choc keycaps (e.g. MBK)*
*<sup>[1]</sup> It simply means that it supports the nice!nano. An on/off switch is recommended for bluetooth*
*<sup>[2]</sup> Choc spaced boards have the switches in a tighter grid. This provides a better final look but is only compatible with some choc keycaps (e.g. MBK)*
*<sup>[3]</sup> Supports splitkb's [tenting puck](https://splitkb.com/products/tenting-puck?_pos=1&_psq=tenting%20&_ss=e&_v=1.0)*

* Sweep2 - Recommended Choc v1 board with all the features.
* Sweep High - Same as the Sweep2 but trades choc spacing for compatibility with more switches and keycaps.
* Sweep Half Swept - Half of a Sweep2 with double pro-micro footprint (letting you avoid having one daughter-board flipped upside-down)
* Sweep Compact Low - The only version that supports Choc minis.

## Firmware

The firmware can be found [with the Ferris firmware as part of QMK](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ferris/sweep).

Firmware for zmk and bluemicro_ble is called ["Cradio"](https://zmk.dev/docs/hardware/).

## BOM

To build a Sweep you will need:
Expand All @@ -45,6 +39,12 @@ To build a Sweep you will need:

I, lazily, haven't made any documentation, but thankfully there is [this tutorial on youtube](https://www.youtube.com/watch?v=fBPu7AyDtkM) by Kyek.

## Firmware

The firmware can be found [with the Ferris firmware as part of QMK](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ferris/sweep).

Firmware for zmk and bluemicro_ble is called ["Cradio"](https://zmk.dev/docs/hardware/).

## Who made this?

* Pierre Chevalier
Expand Down

0 comments on commit f6e81bc

Please sign in to comment.