X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.org;h=14653e79b5545bdfc7da441024f11706a17cfc2c;hb=54ba0cec74e50477669104514f649bae443e3414;hp=e78bc5e58759c1815b083c99b43cb679f3b3f80d;hpb=5a81d541de6421ceba608219517c90cc1d4668e1;p=atreides.git diff --git a/README.org b/README.org index e78bc5e..14653e7 100644 --- a/README.org +++ b/README.org @@ -42,14 +42,14 @@ numpad-style arrangement under the right hand: : ! @ { } | || pgup 7 8 9 * : # $ ( ) ` || pgdn 4 5 6 + - : % ^ [ ] ~ || \ 1 2 3 ? + : % ^ [ ] ~ || & 1 2 3 \ : L2 insert super shift bksp ctrl || alt space fn . 0 = The =L2= key switches it to the function layer, and tapping =L0= here brings it back to the first layer. - : home ↑ end insert pgup || ↑ F7 F8 F9 F10 - : ← ↓ → del pgdn || ↓ F4 F5 F6 F11 + : insert home ↑ end pgup || ↑ F7 F8 F9 F10 + : del ← ↓ → pgdn || ↓ F4 F5 F6 F11 : || F1 F2 F3 F12 : super shift bksp ctrl || alt space L0 reset @@ -73,7 +73,7 @@ quickly. For users that need to operate in sound-sensitive environments like open offices or libraries, [[http://deskthority.net/wiki/Cherry_MX_Clear][Cherry MX Clear]] switches are a popular -choice since they still offer tactility withut the noise. +choice since they still offer tactility without the noise. *** Diodes @@ -104,25 +104,49 @@ that keys that go in different rows have a different shape. While you can use these for an Atreus, it's unlikely you'll find a set with the correct number for each row, so it's more wasteful. +** Circuit Board + +The =atreus.rkt= program calculates switch and diode positions based +on row/column counts, spacing, and rotation factors, and emits a +=atreus.kicad_pcb= file. The board outline and traces are done by hand +and are stored in the =header.rktd= and =traces.rktd= files +respectively. The =atreus.kicad_pcb= file can be imported into [[http://kicad.org][Kicad]] +which can export Gerber files suitable for fabrication. A copy of the +Kicad PCB file is included in the repository if you don't want to +recompile it using Racket. Recompiling is only required if you want to +make changes to the procedurally-generated portions of the board. + +Unfortunately most PCB fabricators require a minimum order of 10 or +so, making this impractical for one-offs. The PCB is not required, so +for one-off boards it's usually more sensible to stick with a [[http://atreus.technomancy.us/assembly-hand-wired.pdf][hand-wired build]] instead. + ** Case -Layered laser-cut wood or acrylic. The original case (=case-mk-i.svg=) -is slightly less wide and has a minor asymmetry with the screws on the -bottom side. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (in the =case= directory) is implemented -programmatically in openscad, though dxf files are available as a -convenience, which can be converted to SVG or EPS for laser cutting -with Inkscape. Mark II features 8 screw holes and a kind of "stair -step" design around the top and bottom of the key clusters; mark I is +Layered laser-cut wood or acrylic. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (EPS files in the +=case/= directory) features 8 screw holes and a kind of "stair step" +design around the top and bottom of the key clusters; mark I is pictured below. -[[./layers.jpg]] +The =3mm.eps= file contains the top plate, bottom plate, and switch +plate. These can all be cut on 3mm acrylic or wood. The =spacer.eps= +file should be cut on something thicker; between 4.5mm and 6mm is +recommended. The spacer needs to be at least as thick as the connector +of the USB cable you're using. + +There is also a programmatically-implemented version of the case +written in OpenSCAD; it is more flexible (you can tweak the number of +rows/cols, etc and recompile) but it doesn't match the canonical case +exactly; in particular the screw holes are placed differently. -The bottom and top covers (black in the photo) should be cut in 3mm. -The switch plate (frosted in the photo) can be cut in 4.5 or -3mm. The spacer should be cut in 5mm; it needs to be at least as -thick as the USB cable you connect to the microcontroller. I -recommend using a USB cable with as thin a connector as you can -find or sanding the connector down to the required thickness. +The original case (=case-mk-i.svg=) design is also included; it is +slightly less wide and has a minor asymmetry with the screws on the +bottom side. + +On a 100W Epilog laser, the 3mm layers cut in about a minute and a +half. I did a run with 6mm acrylic of the other layers which took +nearly 6 minutes. + +Wood cases should be finished with sandpaper and finishing oil/wax. ** Firmware @@ -183,6 +207,8 @@ See the [[http://atreus.technomancy.us/assembly.pdf][assembly instructions]] PDF Hand-wired boards will want the [[http://atreus.technomancy.us/assembly-hand-wired.pdf][previous edition of the assembly instructions]]. +The LaTeX source to the assembly instructions is in the =assembly= directory. + ** Inspiration These fine projects all provided inspiration for various aspects of @@ -197,7 +223,7 @@ the Atreus, as well as the folks on the =#geekhack= freenode channel. If you've built an Atreus, please add your name to [[https://github.com/technomancy/atreus/wiki/BuildLogs][the build logs wiki]]. -There's also a [[http://librelist.com/browser/atreus/][mailing list]] for people who have built or ordered an +There's also a [[http://atreus.technomancy.us/list][mailing list]] for people who have built or ordered an Atreus or are interested in doing so. To join, simply email =atreus@librelist.com= with a subject of "join" and reply to the confirmation. @@ -209,6 +235,6 @@ ARM [[https://github.com/technomancy/orestes/tree/teensy3][Forth-based]] firmwar ** License -Copyright © 2014 Phil Hagelberg and contributors +Copyright © 2014-2015 Phil Hagelberg and contributors Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]