diff --git a/README.md b/README.md deleted file mode 100644 index ea72b6d..0000000 --- a/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# samoklava -## An autogenerated split 36 key keyboard - -left | right --|- -![left](images/board-front.png) | ![right](images/board-back.png) - -A 5x3 split keyboard with 3 thumbs. There is nothing unique about the keyboard layout. It's inspired by Corne and Kyria, and -has the exact number of keys needed for the [Miryoku](https://github.com/manna-harbour/miryoku) layout. - -The interesting thing about this keyboard is that it's a declarative design ("samoklava" can be loosely translated as -"keyboard that assembles itself" from Russian). -* Layout is declared using [Ergogen](https://github.com/mrzealot/ergogen/) -* 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](https://github.com/productize/kicad-automation-scripts) and [FreeRouting](https://github.com/freerouting/freerouting) to **automatically route the traces on the PCB** -* uses [KiKit](https://github.com/yaqwsx/KiKit) to render PCB previews (see top of this file) and production-ready **Gerber files** - -## Features - -* Extra pins and a slider switch for battery for wireless Promicro clones (tested with nice!nano); the slider can be - shorted with a jumper if `CONFIG_ZMK_SLEEP` is preferred. -* Wired operation with QMK should be possible but is not tested; TRRS footprints are included and routed. The pinout is - identical with a five-column Corne sans the RGBLEDs. -* Reset switches are easily accessible. The footprints used are the same as on the Corne. - -## How to - -If you would like to modify this: -* fork it -* change `samoklava.yaml` to your liking -* push your changes; the `build.yml` GitHub 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 `output` folder for KiCad PCBs and Gerbers - -See the [workflow](.github/workflows/build.yml) or the [Makefile](Makefile) for more details. diff --git a/README.org b/README.org new file mode 100644 index 0000000..6df0a02 --- /dev/null +++ b/README.org @@ -0,0 +1,3 @@ +* rae-dux +| [[images/board-front.png]] | [[images/board-back.png]] | +The rae-dux is a keyboard inspired by the [[https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux][Architeuthis Dux]] and built using the [[https://github.com/soundmonster/samoklava][samoklava workflow]]. diff --git a/images/board-back.png b/images/board-back.png index 2f082fe..2ed819e 100644 Binary files a/images/board-back.png and b/images/board-back.png differ diff --git a/images/board-front.png b/images/board-front.png index 0f0ed9f..3eae2fd 100644 Binary files a/images/board-front.png and b/images/board-front.png differ