From a1bb99e1c4611453c858d21e6cd007796f3bba4b Mon Sep 17 00:00:00 2001
From: Colin <colin@uninsane.org>
Date: Fri, 22 Dec 2023 02:58:19 +0000
Subject: [PATCH] README: document how to build

---
 README.md | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 6606771..108e014 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,22 @@ OpenSCAD model for Case for PinePhone
 
 based on [beattie's earlier model](https://github.com/beattie/PinePhone-Case).
 
-WIP phone case for the PinePhone, and associated models.
-
 files:
-- dimensions.scad: dimensions used to build phone module
-- bits.scad:       modules for the bumps on the phone to make holes in the case
-- fillet.scad:     form a rounded bump around the screen opening
-- phone.scad:      a module to make a model of the phone use to carve out a hole for the case
-- case.scad:       make a model for the case
+- case.scad: top-level/entrypoint.
+- defaults.scad: tunable settings which affect the detail of the model.
+- dimensions.scad: measurements of the actual PinePhone, used to assemble the bits.
+- phone.scad: model of the actual PinePhone itself; the case is made by constructing a shell from this model.
+- bits.scad: models of all the cutouts/extrusions which exist on the phone. i.e. buttons, ports, camera.
+
+## use
+- compile the scad to stl:
+```
+make build/case.stl
+```
+
+- slice the stl file using slic3r:
+```
+make build/case.gcode
+```
+
+- then send `build/case.gcode` to your printer.