Add assembly guide source.

[atreides.git] / README.org

diff --git a/README.org b/README.org
index 61028e8e8e826382a5fd30c5c0792229c9a483a6..518a9b419bc8025172afbd2a7ed8ecf1d27c9575 100644 (file)
--- a/README.org
+++ b/README.org
@@ -106,11 +106,25 @@ correct number for each row, so it's more wasteful.
 
 ** Circuit Board
 
-TODO: describe
+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
 
-bottom side. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (in the `case/dxf` directory) is
+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/dxf= directory) is
 available as a DFX file that you can convert to SVG or EPS for a laser
 cutter using 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
@@ -200,6 +214,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
@@ -214,7 +230,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.
@@ -226,6 +242,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]]