diff --git a/README.md b/README.md index 130ef04..1eeb637 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,65 @@ Obviously you can ignore the rows when shopping for uniform key caps. 😉 The USB Vendor ID for noisy cricket is 1209 and Product ID is 4237. You can find it here: https://pid.codes/1209/4237/ +# Build + +## 1. Get all parts + +Order PCBs from PCB Repository, Get gerber files here: https://gitlab.com/noisy_cricket/pcb/-/releases/rev2 + +See BOM here: https://octopart.com/bom-tool/6LG2ivlW + +_Find cheap SK6812MINI-E here: https://www.aliexpress.com/item/4000475685852.html_ + +Other parts needed: + +- Alps EC11 or Bourns PEC11L compatible rotary encoder: https://keycapsss.com/keyboard-parts/parts/59/rotary-encoder-with-switch-ec11?number=KC10028_KS +- Encoder knob: https://www.aliexpress.com/item/32744496347.html +- Kailh compatible hot swap sockets: https://www.aliexpress.com/item/1005003166749340.html +- MX compatible keyboard switches: https://www.aliexpress.com/item/1005005209738936.html +- Threaded inserts M2x2 (OD 3.2mm): https://www.aliexpress.com/item/1005004873154281.html +- Screws + - M2x4mm: https://www.aliexpress.com/item/32810852732.html + - M2x3mm: https://www.aliexpress.com/item/32810852732.html + - M2x3+3: https://www.aliexpress.com/item/1005003328519584.html + - M2x3: https://www.aliexpress.com/item/1005002044837898.html +- Cherry compatible keycaps: https://www.aliexpress.com/item/1005004572499792.html + +## 2. Solder PCB + +Solder the Microcontroller first with a heat gun or heat plate. Then solder crystal next to it. You'll need t firmly press the crystal down so it makes a good connection. Then solder everything else by hand. + +## 3. Software + +Flash QMK firmware from firmware repo: https://gitlab.com/noisy_cricket/qmk-firmware/ + +```shell +git clone https://gitlab.com/noisy_cricket/qmk-firmware/ +cd qmk-firmware +git checkout noisy_cricket +``` + +Connect the board and execute this: + +```shell +make noisy_cricket:default:flash +# or with the QMK tool: qmk flash -kb noisy_cricket -km default +``` + +## 4. Case + +- Get 3D printable case files from https://gitlab.com/noisy_cricket/cad +- Run `make 3mf` to generate printable files +- Print `upper_case.3mf` +- Print `lower_case.3mf` +- Print `plate.3mf` or run `make dxf` and CNC cut `plate.dxf` out of aluminium or brass +- Optionally: CNC `weight.dxf` to further increase the weight of the case +- Optionally: CNC the lower and upper case from wood with the included STEP files + +## 5. Finalize + +Now put everything together and enjoy your new mini gaming keyboard. + --- Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.