This is an early experimental prototype. Please do not rely on the autogenerated files and double check them manually before sending them off to a PCB fab. The author and other random strangers on the internet have been able to produce working keyboard prototypes from this repo; this does not mean that everything will work every time.
The author(s) waive(s) responsibility for any damage or regulatory violations caused by using this software (see license). Please consult your local regulations around radio frequencies and what's allowed for DIY projects in your country.
A 5x3 split keyboard with 4 thumb keys. There is nothing unique about the keyboard layout. It's inspired by Cantor-remix.
The interesting thing about this keyboard is that it's a declarative design:
- Layout is declared using Ergogen. New: no fork needed!
- The build system uses Ergogen to translate YAML to a KiCad PCB and plate files for FR-4 fab or laser cutting
- uses kicad-automation-scripts and FreeRouting to automatically route the traces on the PCB
- uses KiKit to render PCB previews (see top of this file) and production-ready Gerber files
If you would like to modify this:
- fork it
- change
config.yamlto your liking - push your changes; the
build.ymlGitHub Workflow will pick it up, autoroute and generate Gerbers, all in a zip file. See https://github.com/soundmonster/samoklava/actions - or:
- make sure to have Docker CLI and NodeJS installed
- run
make setup clean all - check the
outputfolder for KiCad PCBs and Gerbers
See the workflow or the Makefile for more details. See my ZMK config for a suggested keymap.