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.
This commit is contained in:
2021-01-10 11:41:28 -05:00
committed by sjc
parent b1beb41416
commit 0eb5e9ee57
2 changed files with 35 additions and 8 deletions

31
README.md Normal file
View File

@@ -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