]> git.armaanb.net Git - atreides.git/blobdiff - README.md
Rearrage case files
[atreides.git] / README.md
index 77438cf49cfa0ab6a9fe64adc0340913cc5dc271..a25c2164f71ccc4948c8c2913bdc9ce01bbcecb5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,18 @@ From [Wikipedia](https://en.wikipedia.org/wiki/atreus):
 >The word Atreides refers to one of the sons of Atreus—Agamemnon and Menelaus. The plural form Atreidae or Atreidai refers to both sons collectively; in English, the form Atreides (the same form as the singular) is often used.
 
 ## Case
-The case design is written in OpenSCAD with the intention of 3D printing or laser cutting it, and is easily tweakable to your liking with the variables included in the top of the file.
+The case design is written in OpenSCAD with the intention of laser cutting it, and is easily tweakable to your liking with the variables included in the top of the file. 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 the 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...**.
 
 Wood cases should be finished with sandpaper and lacquer, shellac, or polyurethane.