From 62cfc0d439f1ecb595727b5ddba0be759654c73f Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 30 Mar 2017 14:42:47 +0800 Subject: [PATCH] updated readme --- README.md | 4 ++-- docs/lib-line2d.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7677387..99a37367 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ ## 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 ` 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 ;` 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 `. +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 ; diff --git a/docs/lib-line2d.md b/docs/lib-line2d.md index 0e46d81d..d68fff1f 100644 --- a/docs/lib-line2d.md +++ b/docs/lib-line2d.md @@ -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. -## Parameters +# Parameters - `p1` : 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"`. - `$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 ;