cullmann/ferris-sweep
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readmes

Browse source
This commit is contained in:
Duccio 2021-11-20 02:23:55 +01:00
parent 31fc04aae5
commit 589f0c190d
4 changed files with 25 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -8,12 +8,10 @@ Sweep is a version of the more fabulous [Ferris](https://github.com/pierrecheval
| Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> | | Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Sweep2.x | ✔ | ✔ | | ✔ | | | | ✔ | ✔ | | Sweep2.x | ✔ | ✔ | | ✔ | | | | ✔ | ✔ |
| Sweep High | ✔ | ✔ | | ✔ | ✔ | | ✔ | | ✔ | | Sweep High | ✔ | ✔ | | ✔ | ✔ | | ✔ | | ✔ |
| Sweep Half Swept | ✔ | ✔ | ✔ | ✔ | | | | ✔ | ✔ | | Sweep Half Swept | ✔ | ✔ | ✔ | ✔ | | | | ✔ | ✔ |
| Sweep Compact | ✔ | | ✔ | ✔ | | | | ✔ | |
| Sweep Compact Low | ✔ | | ✔ | | | ✔ | | ✔ | | | Sweep Compact Low | ✔ | | ✔ | | | ✔ | | ✔ | |
| Sweep Compact BLE | ✔ | | ✔ | ✔ | | | | ✔ | |
*<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)*
@ -22,11 +20,7 @@ Sweep is a version of the more fabulous [Ferris](https://github.com/pierrecheval
* Sweep2 - Recommended Choc v1 board with all the features. * 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 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 Half Swept - Half of a Sweep2 with double pro-micro footprint (letting you avoid having one daughter-board flipped upside-down)
* Sweep Compact - A reversible sweep with Choc v1 support.
* ⚠ *Left* half of the Sweep the promicro's USB port must face *towards* the PCB, and on the *right* half the USB port must face *away* from the PCB (so that the promicro's components are visible)
* Sweep Compact Low - The only version that supports Choc minis. * Sweep Compact Low - The only version that supports Choc minis.
* Sweep Compact BLE - Same as the compact but without the TRRS Jack footprint.
* Sweep34 [deprecated] - This was the OG Sweep, before there was a choc spaced Ferris. Use the Sweep Half Swept instead.
## Firmware ## Firmware

8
archive/Sweep Compact BLE/README.md
View file

@ -3,3 +3,11 @@
This is an older revision. This is an older revision.
The Half Swept version is very similar but offers more features. The Half Swept version is very similar but offers more features.
The main difference in this design is the missing TRRS jack footprint.
## Features
| Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Sweep Compact BLE | ✔ | | ✔ | ✔ | | | | ✔ | |

8
archive/Sweep Compact/README.md
View file

@ -3,3 +3,11 @@
This is an older revision. This is an older revision.
The Half Swept version is very similar but offers more features. The Half Swept version is very similar but offers more features.
⚠ *Left* half of the Sweep the promicro's USB port must face *towards* the PCB, and on the *right* half the USB port must face *away* from the PCB (so that the promicro's components are visible)
## Features
| Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Sweep Compact | ✔ | | ✔ | ✔ | | | | ✔ | |

8
archive/Sweep34/README.md
View file

@ -1,5 +1,11 @@
# Sweep 34 # Sweep 34
![](/gallery/sweep-34.jpg) ![](/gallery/sweep-34.jpg)
This is the first ever version of the Sweep! This is the first ever version of the Sweep! It was created before there was a choc spaced Ferris.
The Half Swept version is very similar but offers more features. The Half Swept version is very similar but offers more features.
## Features
| Device | Bluetooth Support<sup>[1]</sup> | On/Off Switch | Reversible PCB | Choc V1 | Choc V2 | Choc Mini | MX & Alps | Choc Spacing<sup>[2]</sup> | Tenting<sup>[3]</sup> |
| :--- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| Sweep 34 | ✔ | | ✔ | ✔ | | | | ✔ | |