| 1 | ## csg.js
|
| 2 |
|
| 3 | ## Constructive Solid Geometry (CSG) Library
|
| 4 |
|
| 5 | [](https://badge.fury.io/gh/jscad%2Fcsg.js)
|
| 6 | [](https://travis-ci.org/jscad/csg.js)
|
| 7 |
|
| 8 | > Solid modelling library (2d & 3d)
|
| 9 |
|
| 10 | ## Overview
|
| 11 |
|
| 12 | Constructive Solid Geometry (CSG) is a modelling technique that uses Boolean operations like union and intersection to combine 3D solids. This library implements CSG operations on meshes elegantly and concisely using BSP trees, and is meant to serve as an easily understandable implementation of the algorithm.
|
| 13 |
|
| 14 | ## Table of Contents
|
| 15 |
|
| 16 | - [Installation](#installation)
|
| 17 | - [Usage](#usage)
|
| 18 | - [API](#api)
|
| 19 | - [Contribute](#contribute)
|
| 20 | - [License](#license)
|
| 21 |
|
| 22 | ## Installation
|
| 23 |
|
| 24 | ```
|
| 25 | npm install @jscad/csg
|
| 26 | ```
|
| 27 |
|
| 28 | ## Usage
|
| 29 |
|
| 30 | - as Node module :
|
| 31 |
|
| 32 | ```
|
| 33 | const csg = require('@jscad/csg')
|
| 34 | ```
|
| 35 |
|
| 36 | ## API
|
| 37 |
|
| 38 | The API documentation can be found [here](./docs/api.md).
|
| 39 |
|
| 40 | Also see the [OpenJsCad User Guide](https://en.wikibooks.org/wiki/OpenJSCAD_User_Guide).
|
| 41 |
|
| 42 | For questions about the API, please contact the [User Group](https://plus.google.com/communities/114958480887231067224)
|
| 43 |
|
| 44 | ## Contribute
|
| 45 |
|
| 46 | This library is part of the JSCAD Organization, and is maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.
|
| 47 |
|
| 48 | * If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/csg.js/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/csg.js/issues/) via GitHub.
|
| 49 |
|
| 50 | * If you want to submit a change or a patch, please see the [Contributing guidelines](https://github.com/jscad/csg.js/blob/master/CONTRIBUTING.md). New contributions are accepted as [Pull Requests](https://github.com/jscad/csg.js/pulls/) via GithHub.
|
| 51 |
|
| 52 | * We only accept bug reports and pull requests on **GitHub**.
|
| 53 |
|
| 54 | * If you have a question about how to use CSG.js, then please start a conversation at the [OpenJSCAD.org User Group](https://plus.google.com/communities/114958480887231067224). You might find the answer in the [OpenJSCAD.org User Guide](https://github.com/Spiritdude/OpenJSCAD.org/wiki/User-Guide).
|
| 55 |
|
| 56 | * If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://plus.google.com/communities/114958480887231067224) and start contributing changes.
|
| 57 |
|
| 58 | Small Note: If editing this README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
| 59 |
|
| 60 | ## Copyrights
|
| 61 |
|
| 62 | Some copyrights apply. Copyright (c) 2012 Joost Nieuwenhuijse (joost@newhouse.nl), under the MIT license. Copyright (c) 2011 Evan Wallace (http://madebyevan.com/)
|
| 63 |
|
| 64 | ## License
|
| 65 |
|
| 66 | [The MIT License (MIT)](https://github.com/jscad/csg.js/blob/master/LICENSE)
|
| 67 | (unless specified otherwise)
|