Skip to content

Commit 867d43b

Browse files
committed
Merge branch 'main' of https://github.com/jon-gilbert/openscad_pvc into main
2 parents b32dd6b + bdebee6 commit 867d43b

File tree

1 file changed

+3
-36
lines changed

1 file changed

+3
-36
lines changed

README.md

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,7 @@ Modules and functions to create PVC pipe models within OpenSCAD
55

66
Models have their dimensions and sizes pulled from existing specifications, organized by PVC schedule and size, so they should be sized the same as parts found in a hardware store. PVC parts modeled here come with simple BOSL2 attachable endpoints, so joining parts together relatively easy when constructing pipe layouts or new component parts.
77

8-
# Usage
9-
10-
Models start by selecting a PVC specification. A range of public PVC specifications are inline to the library: they define diameters and thicknesses and thread sizing for existing piping.
11-
12-
Once a specification is selected, it can be reused over and over to create individual PVC parts.
13-
14-
Individual PVC parts can be quickly modeled and attached to each other using BOSL2's Attachment feature.
15-
16-
A simple example:
17-
18-
```
8+
```openscad
199
pvc = pvc_spec_lookup(schedule=40, dn="DN20");
2010
pvc_flange(pvc)
2111
attach("B", "A")
@@ -27,36 +17,13 @@ pvc_flange(pvc)
2717
```
2818
...would yield something that looks like:
2919

30-
![](docs/images/openscad_pvc/section-pvc-component-part-modules_fig1.png)
31-
32-
There's other examples in [the examples directory](examples/), and a full overview on selecting PVC specifications by schedule, and on joining individual PVC parts, can be found in [the docs](docs/openscad_pvc.scad.md).
20+
![](https://github.com/jon-gilbert/openscad_pvc/blob/main/docs/images/openscad_pvc/section-pvc-component-part-modules_fig1.png)
3321

3422
# Installation
35-
3623
Installing this library should be as simple as downloading the .scad file and copying it to your OpenSCAD library directory:
3724
```
3825
wget -N -q -O openscad_pvc.scad https://raw.githubusercontent.com/jon-gilbert/openscad_pvc/main/openscad_pvc.scad
3926
```
40-
The library directory will vary based on your OS; see https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Libraries#Library_locations for the correct location for you.
41-
42-
## Required OpenSCAD Version
43-
Building and using the `openscad_pvc` library requires OpenSCAD 2021.01 or later. Visit https://openscad.org/ for installation instructions.
44-
45-
## Requried External Libraries
46-
47-
### BOSL2
48-
Belfry OpenSCAD Library (v.2). Authored by a number of contributors. Located at https://github.com/revarbat/BOSL2
49-
50-
To download this library, follow the instructions provided at https://github.com/revarbat/BOSL2#installation
51-
52-
### openscad_objects: object_common_functions.scad
53-
Objectifed OpenSCAD library. Authored by Jonathan Gilbert. Located at https://github.com/jon_gilbert/openscd_objects
54-
55-
To download this library,
56-
```
57-
wget -N -q -O object_common_functions.scad https://raw.githubusercontent.com/jon-gilbert/openscad_objects/main/object_common_functions.scad
58-
```
59-
...and copy it to OpenSCAD's library directory.
60-
27+
Additional information on external libraries needed can be found at [the Installation wiki](https://github.com/jon-gilbert/openscad_pvc/wiki/Installation).
6128

6229

0 commit comments

Comments
 (0)