From 079288e7b61d425cfa755862c413df1356911425 Mon Sep 17 00:00:00 2001 From: Petar Obradovic Date: Tue, 6 Aug 2024 19:11:57 +0200 Subject: [PATCH] updates readme --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6a25612..9822342 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # 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. ![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 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) @@ -44,11 +47,13 @@ You can also buy a kit to build the Cantor keyboard from one of the **honorable



- + ### Bill of Materials To build the keyboard, you will need the following materials: + #### Cantor Classic: + - 2x PCB boards (both are equal since they are reversible) - 2x STM32F401CC blackpill microcontrollers (they are cheap on aliexpress) - 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 #### 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. - 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 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. ### How to Build @@ -103,7 +107,6 @@ GitHub: [Here](https://github.com/sponsors/diepala) ### Honorable sponsors - Thank you very much to everyone contributing and/or sponsoring this project. Special thanks to the honorable sponsors: