diff --git a/README.md b/README.md index 2c5c2cc..73c27ff 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,8 @@ -# Project: Build a keyboard +# Project: Build a split keyboard -!! This is a work-in-progress !! +**⚠ This is still a work-in-progress ⚠** --> [schematics](docs/schematic.md) - -## Preview -![prototyp}e](./images/prototype.jpeg) - -![kicad image](images/kicad.jpeg) +A 56 keys column-staggered fully-wireless split keyboard with scrollwheels. ## Features @@ -18,3 +13,34 @@ - Fully wireless built for Nice!Nano + ZMK (no TRRS Jack) - Nice!View support (5 pin connector) - Reversible PCB + +## Gallery + +![prototype](./images/build.jpg) +![kicad image](images/pcb.png) + +## 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**: + +| **Item** | **Count** | **Note** | +|---------------------------------|-----------|----------| +| Nice!View + mounts | 2 | | +| Switchplate | 2 | Height: 1.2mm; either 3d printed or cut pcbs | +| Silicone feet | 8 | | \ No newline at end of file diff --git a/images/back.png b/images/back.png deleted file mode 100644 index 1a6d32a..0000000 Binary files a/images/back.png and /dev/null differ diff --git a/images/build.jpg b/images/build.jpg new file mode 100644 index 0000000..524c171 Binary files /dev/null and b/images/build.jpg differ diff --git a/images/front.png b/images/front.png deleted file mode 100644 index 877ce6b..0000000 Binary files a/images/front.png and /dev/null differ diff --git a/images/keyboard_back_rendered.png b/images/keyboard_back_rendered.png deleted file mode 100644 index 0b143a7..0000000 Binary files a/images/keyboard_back_rendered.png and /dev/null differ diff --git a/images/keyboard_front_rendered.png b/images/keyboard_front_rendered.png deleted file mode 100644 index bf29782..0000000 Binary files a/images/keyboard_front_rendered.png and /dev/null differ diff --git a/images/kicad.jpeg b/images/kicad.jpeg deleted file mode 100644 index b64d224..0000000 Binary files a/images/kicad.jpeg and /dev/null differ diff --git a/images/pcb.png b/images/pcb.png new file mode 100644 index 0000000..0be050b Binary files /dev/null and b/images/pcb.png differ diff --git a/images/pcb_front.png b/images/pcb_front.png new file mode 100644 index 0000000..2f79a72 Binary files /dev/null and b/images/pcb_front.png differ diff --git a/images/prototype.jpeg b/images/prototype.jpeg deleted file mode 100644 index 3013e53..0000000 Binary files a/images/prototype.jpeg and /dev/null differ