diff --git a/README b/README index 510d653..34b4f1c 100644 --- a/README +++ b/README @@ -1,11 +1,20 @@ OpenSCAD MCAD Library ===================== -This library contains components commonly used in designing and moching up mechanical designs. It is currently unfinished and still undergoing considerable API changes however many things are already working. +This library contains components commonly used in designing and moching up +mechanical designs. It is currently unfinished and you can expect some API +changes, however many things are already working. This library is licensed under the LGPL 2.1 See http://creativecommons.org/licenses/LGPL/2.1/ or the included file, lgpl-2.1.txt. +== Usage == +You can import these files in your scripts with "use ", but some +files include useful constants which will be available with "include ", +which should be safe to use on all included files (ie. no top level code should +create geometry). + + Currently Provided Tools: * involute_gears.scad (http://www.thingiverse.com/thing:3575): @@ -31,7 +40,27 @@ Utils: * constants.scad: mathematical constants * curves.scad: mathematical functions defining curves * units.scad: easy metric units -* utilities: geometric funtions and misc. useful stuff -* teardrop (http://www.thingiverse.com/thing:3457): parametric teardrop module +* utilities.scad: geometric funtions and misc. useful stuff +* teardrop.scad (http://www.thingiverse.com/thing:3457): parametric teardrop module -You are welcome to fork this project in github and request pulls. I will try to accomodate the community as much as possible in this. +== Development == +You are welcome to fork this project in github and request pulls. I will try to +accomodate the community as much as possible in this. If for some reason you +want collaborator access, just ask. + +Github is fun (and easy), but I can include code submissions and other +improvements directly, and have already included code from various sources +(thingiverse is great :) + +=== Code style === +I'd prefer to have all included code nicely indented, at least at the block +level, and no extraneous whitespace. I'm used to indent with four spaces as +opposed to tabs or other mixes of whitespace, but at least try to choose a style +and stick to it. + +=== Testing === +I've started a minimal testing infrastucture for OpenSCAD code. It's written in +python and uses py.test (might be compatible with Nose also). Just type py.test +inside the lib dir in a terminal and you should see a part of the tests passing +and tracebacks for failing tests. It's very simplistic still, but it should test +that no syntax errors occur at least. diff --git a/teardrop.scad b/teardrop.scad index 0d1c064..7a3b0fe 100644 --- a/teardrop.scad +++ b/teardrop.scad @@ -26,3 +26,5 @@ module test_teardrop(){ translate([0, 0, 0]) teardrop(5, 20, 60); translate([0, 15, 0]) teardrop(5, 20, 45); } + +//test_teardrop();