diff --git a/README b/README new file mode 100644 index 0000000..0d3da34 --- /dev/null +++ b/README @@ -0,0 +1,14 @@ +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 is dual licensed under the GPL 3.0 and the GNU Lesser General Public License as per http://creativecommons.org/licenses/LGPL/2.1/ . + +Currently Provided Tools: + - gear(number_of_teeth, circular_pitch OR diametrial_pitch, pressure_angle OPTIONAL, clearance OPTIONAL) + - stepper_motor_mount(nema_standard, slide_distance OPTIONAL, mochup OPTIONAL) + +Tools for creating metric and imperial bolt/nut holes as well as standard/custom bearings are here but are not as usable as those listed above. + +You are welcome to fork this project in github and request pulls. I will try to accomidade the community as much as possible in this.