Updating readme.

This commit is contained in:
Andrew Rae 2022-01-17 19:51:23 -05:00
parent a7de29472a
commit c1fddbe106

View file

@ -1,12 +1,21 @@
* rae-dux * rae-dux
| [[images/board-front.png]] | [[images/board-back.png]] | | [[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!* *Has yet to be printed and tested!*
** Changes from samoklava ** Important Notes
- Added a-dux like splay, fitted to my hand - Wireless only, the 36-key diodeless approach uses the P0 pin which is usually dedicated to TRRS
+ Filled in holes that came from the new splay by using the bind functionality - Their is only one MCU footprint, so one controller has to be flipped (I assume
+ *Important*: had to ensure that the MCU footprint was upright otherwise auto-routing failed if you can get this printed you can figure out the correct orientation)
- Removed case holes and case - 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.