From 0eb5e9ee57c33245665a6adf146002dc2fa73d7e Mon Sep 17 00:00:00 2001
From: Stephen Carpenter <sjc@carpanet.net>
Date: Sun, 10 Jan 2021 11:41:28 -0500
Subject: [PATCH] Added README.md

Added README.md and cleaned up some commented values. Set rot for animation range.
Should be almost ready for initial public release.
---
 GearHinge.scad | 12 ++++--------
 README.md      | 31 +++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+), 8 deletions(-)
 create mode 100644 README.md

diff --git a/GearHinge.scad b/GearHinge.scad
index 6635261..52fb936 100644
--- a/GearHinge.scad
+++ b/GearHinge.scad
@@ -21,11 +21,12 @@ helix_angle = [ for (x=linspace(-1,1,helix_steps)) exp(-abs(x))*10*sign(x) ];
 
 //helix_angle = constant(axis_angle/2);
 //width = 10;
-width=10;
-N = 9;
+width=10; // width of the actual gears.
+N = 9;    // Number of gear teeth.
 // Force same number of teeth
 N1=N;
 N2=N;
+
 Module=1.45;
 
 ShaftD=4.5;
@@ -40,12 +41,7 @@ BackW=Swing+Module;
 SideW=tol+BackW;
 
 echo("Reference Diameter (MeshD): ", MeshD);
-//rot=360/N1*$t;
-//rot=90*$t;
-//rot=20*$t +75;
-rot=0;
-//rot=00;
-//axis_angle = -50;
+rot=90*$t;
 	
 //meshed(rot=rot);
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5423e61
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# GearHinge
+
+GearHinge is an openscad model of a geared hinge. This was developed as part 
+of another project, but stands on its own as a part that could be re-used.
+
+It is designed to be printed in place and without support materials. Gears
+should be rotates into the case (rot = 0) for printing.
+
+## usage
+
+```openscad
+include <GearHinge.scad>
+
+$incolor = true;
+
+gear_hinge(rot=rot, box=false, rounded_case=true);
+```
+
+## Status/Known Issues
+
+Under development, not ready for the unadventurous.
+
+1. Arms have no mounting holes for general use.
+2. No functions/workflow exists for attaching arms to anything else.
+3. Module is 1.45; it should be parametric. Hard coded values must go.
+4. Cannot be assembled or disassembled; must be printed in place.
+5. Helix angle can only do a single "turn". Should be re-written to use sin.
+
+## License
+
+See License.txt file