Kabbone/Sweep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #29 from Bhanukamax/rearrange_readme

Browse Source 
Re-arrange readme
This commit is contained in:
Duccio 2022-01-01 12:20:35 +01:00 committed by GitHub
commit 7f96a9b1f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -15,8 +15,8 @@ Sweep is a version of the more fabulous [Ferris](https://github.com/pierrecheval
| Sweep Half Swept | ✔ | ✔ | ✔ | ✔ | | | | ✔ | ✔ | | Sweep Half Swept | ✔ | ✔ | ✔ | ✔ | | | | ✔ | ✔ |
| Sweep Compact Low | ✔ | | ✔ | | | ✔ | | ✔ | | | Sweep Compact Low | ✔ | | ✔ | | | ✔ | | ✔ | |
*<sup>[1]</sup> It simply means that it supports the nice!nano. An on/off switch is recommended for bluetooth* *<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>[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)* *<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. * Sweep2 - Recommended Choc v1 board with all the features.
@ -24,12 +24,6 @@ Sweep is a version of the more fabulous [Ferris](https://github.com/pierrecheval
* Sweep Half Swept - Half of a Sweep2 with double pro-micro footprint (letting you avoid having one daughter-board flipped upside-down) * 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. * 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 ## BOM
To build a Sweep you will need: To build a Sweep you will need:
@ -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. 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? ## Who made this?
* Pierre Chevalier * Pierre Chevalier