diff --git a/README.md b/README.md index 825d30c..d91f971 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Corax56: A 56 keys column-staggered fully-wireless split keyboard with scrollwheels. +# Corax: A column-staggered fully-wireless split keyboard with scrollwheels. - Choc-spaced, hot-swappable -- 56 keys (4 thumb keys, 4 key pinky cluster) +- Two versions: with 45 or 54 keys - Scrollwheel (EVQWGD001) on both sides - Strong pinky stagger (0.66) and a 5 deg. pinky splay - Fully wireless built for Nice!Nano + ZMK (no TRRS Jack) @@ -19,46 +19,25 @@ ![pcb](./images/pcb.jpg) ![top](./images/pcb_render_front.jpg) -## Bill of materials -**Essentials**: -| **Item** | **Count** | **Note** | -|---------------------------------|-----------|----------| -| Keyboard PCB | 2 | | -| Nice!Nano | 2 | | -| 12 pin headers and sockets | 4 | You can use through-hole diode legs as pins. Sockets spacing: 2.54mm, Socket height: Using minimal height sockets might not leave enough room to mount the battery under the MCU. 3DS1002-01-1*20V13-JK by CONNFLY are a good choice, but you can also use lower ones and longer legs instead. Spiltkb has a good [guide on mounting](https://docs.splitkb.com/hc/en-us/articles/360011263059). | -| LiPo battery (301230) | 2 | 110mAh | -| Kailh Choc v1 switches (PG1350) | 56 | | -| Keycaps | 56 | | -| Kailh Choc hotswap sockets | 56 | | -| Encoder EVQWGD001 | 2 | | -| Diodes 1N4148W | 58 | for each key + encoder | -| Buttons | 2 | reset buttons; 2 pins through-hole, tactile, 3x6x4.3mm | -| Slider Switches | 2 | on/off switches; SMD, C128955 | -| USB-C Cable | 1 | for copying the firmware +## Corax56 vs Corax54 - -**Optional**: - -| **Item** | **Count** | **Note** | -|---------------------------------|-----------|----------| -| Nice!View + mounts | 2 | | -| Switchplate | 2 | Height: 1.2mm; either 3d printed or cut pcbs. [stl](./3dprints/switchplate/) | -| Case (Left + Right) | 1 | see [here](./3dprints/case/). | -| Silicone feet | 8 | | +I initially designed the Corax56 (=56 keys) with 4 pinky keys. The upper key (usually mapped to ESC) was placed in a new column because I found it easier to reach horizontally than vertically. +Over the time, I realized that I am not using this button very often. The Corax54 was born as a more compact version where the pinky cluster misses this additonal column and has only 54 keys (2 less). This is the only difference between the two versions. ## Firmware -Only supports ZMK. The firmware repository can be found here: [https://github.com/dnlbauer/corax56-zmk-config](https://github.com/dnlbauer/corax56-zmk-config). +Natively supports [ZMK](https://zmk.dev/). ## Build guide TODO -## TODO List -- [ ] Use github actions to build + release gerber files. -- [ ] Write a build guide - ## Standing on the shoulders of giants - A great tutorial I referenced a lot by FlatFootFox: https://flatfootfox.com/ergogen-introduction/ - Lots of inspiration and ideas for this project came from these boards: [Choccy](https://github.com/sprengboard/choccy), [Sofle](https://github.com/josefadamcik/SofleKeyboard), [brain](https://github.com/Wesztman/brain), [spleeb](https://github.com/chrishoage/spleeb) + + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/corax54/README.md b/corax54/README.md new file mode 100644 index 0000000..623e29d --- /dev/null +++ b/corax54/README.md @@ -0,0 +1,35 @@ +# Corax54 + +## Bill of materials + +**Essentials**: +| **Item** | **Count** | **Note** | +|---------------------------------|-----------|----------| +| Keyboard PCB | 2 | | +| Nice!Nano | 2 | | +| 12 pin headers and sockets | 4 | You can use through-hole diode legs as pins. Sockets spacing: 2.54mm, Socket height: Using minimal height sockets might not leave enough room to mount the battery under the MCU. 3DS1002-01-1*20V13-JK by CONNFLY are a good choice, but you can also use lower ones and longer legs instead. Spiltkb has a good [guide on mounting](https://docs.splitkb.com/hc/en-us/articles/360011263059). | +| LiPo battery (301230) | 2 | 110mAh | +| Kailh Choc v1 switches (PG1350) | 54 | | +| Keycaps | 54 | | +| Kailh Choc hotswap sockets | 54 | | +| Encoder EVQWGD001 | 2 | | +| Diodes 1N4148W | 56 | for each key + encoder | +| Buttons | 2 | reset buttons; 2 pins through-hole, tactile, 3x6x4.3mm | +| Slider Switches | 2 | on/off switches; SMD, C128955 | +| USB-C Cable | 1 | for copying the firmware + + +**Optional (Displays, 3d printed case)**: + +| **Item** | **Count** | **Note** | +|---------------------------------|-----------|----------| +| Nice!View + mounts | 2 | | +| Switchplate | 2 | Height: 1.2mm; either 3d printed or cut pcbs. [stl](./3dprints/switchplate/) | +| Case (Left + Right) | 1 | see [here](./3dprints/case/). | +| Silicone feet | 8 | | + +## Firmware + +The firmware repository can be found here: [https://github.com/dnlbauer/corax54-zmk-config](https://github.com/dnlbauer/corax54-zmk-config). + + diff --git a/corax56/README.md b/corax56/README.md new file mode 100644 index 0000000..6693ade --- /dev/null +++ b/corax56/README.md @@ -0,0 +1,34 @@ +# Corax56 + +## Bill of materials + +**Essentials**: +| **Item** | **Count** | **Note** | +|---------------------------------|-----------|----------| +| Keyboard PCB | 2 | | +| Nice!Nano | 2 | | +| 12 pin headers and sockets | 4 | You can use through-hole diode legs as pins. Sockets spacing: 2.54mm, Socket height: Using minimal height sockets might not leave enough room to mount the battery under the MCU. 3DS1002-01-1*20V13-JK by CONNFLY are a good choice, but you can also use lower ones and longer legs instead. Spiltkb has a good [guide on mounting](https://docs.splitkb.com/hc/en-us/articles/360011263059). | +| LiPo battery (301230) | 2 | 110mAh | +| Kailh Choc v1 switches (PG1350) | 56 | | +| Keycaps | 56 | | +| Kailh Choc hotswap sockets | 56 | | +| Encoder EVQWGD001 | 2 | | +| Diodes 1N4148W | 58 | for each key + encoder | +| Buttons | 2 | reset buttons; 2 pins through-hole, tactile, 3x6x4.3mm | +| Slider Switches | 2 | on/off switches; SMD, C128955 | +| USB-C Cable | 1 | for copying the firmware + + +**Optional (Displays, 3d printed case)**: + +| **Item** | **Count** | **Note** | +|---------------------------------|-----------|----------| +| Nice!View + mounts | 2 | | +| Switchplate | 2 | Height: 1.2mm; either 3d printed or cut pcbs. [stl](./3dprints/switchplate/) | +| Case (Left + Right) | 1 | see [here](./3dprints/case/). | +| Silicone feet | 8 | | + +## Firmware + +The firmware repository can be found here: [https://github.com/dnlbauer/corax56-zmk-config](https://github.com/dnlbauer/corax56-zmk-config). +