X-Git-Url: http://git.armaanb.net/?a=blobdiff_plain;f=case%2Fopenscad_3D%2FREADME.md;fp=case%2Fopenscad_3D%2FREADME.md;h=1e58877c135c7d37b5cbc88bf7e71a9dec148fde;hb=77d6aed470eb668e00bce8730c12fa6733559cc1;hp=0000000000000000000000000000000000000000;hpb=4442b9da6eedfac47886ca10464de79e48c4a916;p=atreides.git

diff --git a/case/openscad_3D/README.md b/case/openscad_3D/README.md
new file mode 100644
index 0000000..1e58877
--- /dev/null
+++ b/case/openscad_3D/README.md
@@ -0,0 +1,21 @@
+# OpenSCAD Atreides case design
+
+This directory contains a copy `atreides_3D.scad` of the original OpenSCAD script `atreides_case.scad` that generates Atreides case designs using a number of parameters and is rendered for 3D printing.
+
+The main parameters are:
+
+  - `angle` : one half of the angle between the left and the right groups of keys
+  - `n_rows`, `n_cols` : number of rows and columns to use
+  - `staggering_offsets` : column staggering offsets
+  - `cable_hole_width` : width of the hole for the USB cable
+  - `hand_separation` : distance between the left and the right groups of keys
+  - `screw_hole_radius` : radius of screw holes
+  - `use_notched_holes` (boolean) : whether notched Cherry MX switch holes are desired
+
+See comments in `atreides_case.scad` for details.
+
+To use, open this script in OpenSCAD, select **Compile and Render (CGAL)** in the **Design** menu, then select **Export as DXF...**.
+
+Use OpenSCAD to export .stl as necessary.
+
+Please note that the OpenSCAD version of the case is not a direct port of the canonical DXF; the screw placement is a little bit different, and the curve of the bottom edge sticks out a bit more.