From 5c393f50a5d62948df4bab470f52f791a1401cd2 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Mon, 27 Mar 2017 17:34:32 +0800 Subject: [PATCH] updated readme --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7666f8a6..82926c9a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ # dotSCAD -> These fundamental modules are helpful when playing OpenSCAD. +> These fundamental modules and functions are helpful when playing OpenSCAD. [![license/LGPL](https://img.shields.io/badge/license-LGPL-blue.svg)](https://github.com/JustinSDK/lib-openscad/blob/master/LICENSE) -I've been using OpenSCAD for years and created some funny things. Some of them include several important ideas and details. To prevent forgetfulness, I decided to [write them down](https://openhome.cc/eGossip/OpenSCAD/). Some examples developed in the documentation are useful so I elaborate them into this library. +Every module or function is located in the file which has the same name as the module or the function. For examples, if you want to use the `line2d` module to draw a line, `include ` first. + + include ; + line2d(p1 = [0, 0], p2 = [5, 0], width = 1); + +Some modules may depend on other modules. For example, the `polyline2d` module depends on the `line2d` module, so you also have to `include ` besides `include `. + + include ; + include ; + polyline2d(points = [[1, 2], [-5, -4], [-5, 3], [5, 5]], width = 1); ## Documentation @@ -30,4 +39,8 @@ I've been using OpenSCAD for years and created some funny things. Some of them i - [archimedean_spiral](https://openhome.cc/eGossip/OpenSCAD/lib-archimedean_spiral.html) - Other - - [box_extrude](https://openhome.cc/eGossip/OpenSCAD/lib-box_extrude.html) \ No newline at end of file + - [box_extrude](https://openhome.cc/eGossip/OpenSCAD/lib-box_extrude.html) + +## About dotSCAD + +I've been using OpenSCAD for years and created some funny things. Some of them include several important ideas and details. To prevent forgetfulness, I decided to [write them down](https://openhome.cc/eGossip/OpenSCAD/). Some examples developed in the documentation are useful so I elaborate them into this library. \ No newline at end of file