From c1fddbe106d4e6c007ceab38933b0b3516fcd2e1 Mon Sep 17 00:00:00 2001 From: Andrew Rae Date: Mon, 17 Jan 2022 19:51:23 -0500 Subject: [PATCH] Updating readme. --- README.org | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.org b/README.org index 3d5cab2..3866731 100644 --- a/README.org +++ b/README.org @@ -1,12 +1,21 @@ * 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]]. +The rae-dux is a 36-key (diodeless!), wireless keyboard inspired by the [[https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux][Architeuthis Dux]]. +This project used to use the [[https://github.com/soundmonster/samoklava][samoklava workflow]], however the auto-router had +troubles with the splay, currently I just use the image generating parts of the +samoklava workflow. *Has yet to be printed and tested!* -** Changes from samoklava -- Added a-dux like splay, fitted to my hand - + Filled in holes that came from the new splay by using the bind functionality - + *Important*: had to ensure that the MCU footprint was upright otherwise auto-routing failed -- Removed case holes and case +** Important Notes +- Wireless only, the 36-key diodeless approach uses the P0 pin which is usually dedicated to TRRS +- Their is only one MCU footprint, so one controller has to be flipped (I assume + if you can get this printed you can figure out the correct orientation) +- The [[./rae-dux.yaml][rae-dux.yaml]] file relies on [[https://github.com/andrewjrae/ergogen/tree/rae-dux][my fork of ergogen]] which naturally relies on + [[https://github.com/soundmonster/ergogen/tree/samoklava][soundmonster's fork of ergogen]], and a simple JST battery footprint inspired by + [[https://github.com/benvallack][@benvallack]]. +- If you want to skip out on the switch, there is no jumper to use the JST + connector, so you'll have to bodge a wire somewhere, or try shorting the + switch footprint. +- Kicad files are 6.0, so unfortunately not backwards compatible.