openscad/dotSCAD
1
0
Fork 0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-08-26 07:55:16 +02:00
Code Issues Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Justin Lin
2017-03-30 14:42:47 +08:00
parent 54eb382ff6
commit 62cfc0d439
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -6,13 +6,13 @@
## Introduction ## Introduction
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 <line2d.scad>` first. 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 <line2d.scad>;` first.
include <line2d.scad>; include <line2d.scad>;
line2d(p1 = [0, 0], p2 = [5, 0], width = 1); 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 <line2d.scad>` besides `include <polyline3d.scad>`. Some modules may depend on other modules. For example, the `polyline2d` module depends on the `line2d` module, so you also have to `include <line2d.scad>;` besides `include <polyline3d.scad>;`.
include <line2d.scad>; include <line2d.scad>;
include <polyline3d.scad>; include <polyline3d.scad>;

6
docs/lib-line2d.md
View File

@@ -1,8 +1,8 @@
# line2d line2d
Creates a line from two points. When the end points are `CAP_ROUND`, you can use `$fa`, `$fs` or `$fn` to controll the `circle` module used internally. Creates a line from two points. When the end points are `CAP_ROUND`, you can use `$fa`, `$fs` or `$fn` to controll the `circle` module used internally.
## Parameters # Parameters
- `p1` : 2 element vector `[x, y]`. - `p1` : 2 element vector `[x, y]`.
- `p2` : 2 element vector `[x, y]`. - `p2` : 2 element vector `[x, y]`.
@@ -11,7 +11,7 @@ Creates a line from two points. When the end points are `CAP_ROUND`, you can use
- `p2Style` : The end-cap style of the point `p2`. The value must be `"CAP_BUTT"`, `"CAP_SQUARE"` or `"CAP_ROUND"`. The default value is `"CAP_SQUARE"`. - `p2Style` : The end-cap style of the point `p2`. The value must be `"CAP_BUTT"`, `"CAP_SQUARE"` or `"CAP_ROUND"`. The default value is `"CAP_SQUARE"`.
- `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. - `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details.
## Examples # Examples
include <line2d.scad>; include <line2d.scad>;