Decentrala/cantor
13
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updates readme

Browse Source
This commit is contained in:
Petar Obradovic 2024-08-06 19:11:57 +02:00
parent 5bdae8c047
commit 079288e7b6
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,4 +1,7 @@
# Cantor Keyboard # Cantor Keyboard
### Fork of https://github.com/diepala/cantor
The Cantor keyboard is a 42 key diodeless split keyboard, designed with simplicity in mind. It is inspired on the popular [corne](https://github.com/foostan/crkbd), [ferris](https://github.com/pierrechevalier83/ferris) and [sweep](https://github.com/davidphilipbarr/Sweep) keyboards, aiming to provide a more ergonomic (stronger column stagger) corne-like layout with a simple, easy to assemble and cheap design. The Cantor keyboard is a 42 key diodeless split keyboard, designed with simplicity in mind. It is inspired on the popular [corne](https://github.com/foostan/crkbd), [ferris](https://github.com/pierrechevalier83/ferris) and [sweep](https://github.com/davidphilipbarr/Sweep) keyboards, aiming to provide a more ergonomic (stronger column stagger) corne-like layout with a simple, easy to assemble and cheap design.
![Cantor Keyboard](assets/cantor_keyboard.jpg) ![Cantor Keyboard](assets/cantor_keyboard.jpg)
@ -7,7 +10,7 @@ There are two versions of the Cantor:
The **Cantor Classic** uses choc switches with choc spacing. Therefore, only MBK keycaps can be used. The **Cantor Classic** uses choc switches with choc spacing. Therefore, only MBK keycaps can be used.
The **Cantor MX** uses either choc V1, choc V2, or MX switches with the slightly larger MX spacing. Keycaps for MX stems can be used. (OEM/SA/XDM/Cherry, etc.) The **Cantor MX** uses either choc V1, choc V2, or MX switches with the slightly larger MX spacing. Keycaps for MX stems can be used. (OEM/SA/XDM/Cherry, etc.)
![Cantor Keyboard](/doc/assets/Comparison_overlay_flattened.svg) ![Cantor Keyboard](/doc/assets/Comparison_overlay_flattened.svg)
@ -44,11 +47,13 @@ You can also buy a kit to build the Cantor keyboard from one of the **honorable
<a href="https://shop.beekeeb.com" target="_blank"><img src="https://beekeeb.com/beekeeb-logo.png" align="left" width="200" ></a> <a href="https://shop.beekeeb.com" target="_blank"><img src="https://beekeeb.com/beekeeb-logo.png" align="left" width="200" ></a>
<a href="https://42keebs.eu" target="_blank"><img src="https://user-images.githubusercontent.com/25749629/194108923-33d79eb9-c6da-495b-a60e-fd3f4cd073f4.png" align="left" width="200" ></a> <a href="https://42keebs.eu" target="_blank"><img src="https://user-images.githubusercontent.com/25749629/194108923-33d79eb9-c6da-495b-a60e-fd3f4cd073f4.png" align="left" width="200" ></a>
<br><br><br><br> <br><br><br><br>
### Bill of Materials ### Bill of Materials
To build the keyboard, you will need the following materials: To build the keyboard, you will need the following materials:
#### Cantor Classic: #### Cantor Classic:
- 2x PCB boards (both are equal since they are reversible) - 2x PCB boards (both are equal since they are reversible)
- 2x STM32F401CC blackpill microcontrollers (they are cheap on aliexpress) - 2x STM32F401CC blackpill microcontrollers (they are cheap on aliexpress)
- Pins and sockets for the microcontrollers (blackpill needs 20 pin stripes) - Pins and sockets for the microcontrollers (blackpill needs 20 pin stripes)
@ -60,16 +65,15 @@ To build the keyboard, you will need the following materials:
- 1x USB cable compatible with your computer and the blackpill - 1x USB cable compatible with your computer and the blackpill
#### Cantor MX #### Cantor MX
- Same as the classic, but switches can be choc v1, choc v2, MX 5 pin, or MX 3pin, and the compatible keycaps for chosen switches. MX 5 pin are preferable to 3 pin because they have more points of contact with the PCB. - Same as the classic, but switches can be choc v1, choc v2, MX 5 pin, or MX 3pin, and the compatible keycaps for chosen switches. MX 5 pin are preferable to 3 pin because they have more points of contact with the PCB.
- Cantor MX has slots for optional 'Tenting pucks'. They can be [purchased](https://splitkb.com/products/tenting-puck) or [3d printed](https://www.printables.com/model/235433-tenting-puck-for-keyboard-tripod-mount). - Cantor MX has slots for optional 'Tenting pucks'. They can be [purchased](https://splitkb.com/products/tenting-puck) or [3d printed](https://www.printables.com/model/235433-tenting-puck-for-keyboard-tripod-mount).
### Order the PCB ### Order the PCB
Download the gerber file from releases, and submit it to your favorite PCB manufacturer. The keyboard designs have been tested with JLCPCB. More details on the ordering process can be found in the [PCB Ordering Guide](doc/pcb_ordering_guide.md). Download the gerber file from releases, and submit it to your favorite PCB manufacturer. The keyboard designs have been tested with JLCPCB. More details on the ordering process can be found in the [PCB Ordering Guide](doc/pcb_ordering_guide.md).
Note: if you don't want a random tracking number to be printed in the PCB, make sure to select the option 'Remove Order Number' in JLCPCB. Note: if you don't want a random tracking number to be printed in the PCB, make sure to select the option 'Remove Order Number' in JLCPCB.
### How to Build ### How to Build
@ -103,7 +107,6 @@ GitHub: [Here](https://github.com/sponsors/diepala)
### Honorable sponsors ### Honorable sponsors
Thank you very much to everyone contributing and/or sponsoring this project. Special thanks to the honorable sponsors: Thank you very much to everyone contributing and/or sponsoring this project. Special thanks to the honorable sponsors:
<a href="https://shop.beekeeb.com" target="_blank"><img src="https://beekeeb.com/beekeeb-logo.png" align="left" width="200" ></a> <a href="https://shop.beekeeb.com" target="_blank"><img src="https://beekeeb.com/beekeeb-logo.png" align="left" width="200" ></a>