diff --git a/README.md b/README.md index f4dc559..1803358 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # OpenJsCad +Enthousiastic about OpenSCAD but somewhat frustrated by the limitations of its language, here is an alternative using Javascript. It's free, completely open source, still seriously under construction, based on Evan Wallace's CSG.js library and can be used from within the Chrome browser. + +Launch your Chrome browser and go to: joostn.github.com/OpenJsCad/ + +The benefits over openSCAD are mainly in the language itself: you can use dynamic arrays for example, and solids can be stored in variables. + +# Contribute + +Contributions are welcome, fork me on GitHub! + +The only contents here is the 'GUI' part, in the gh-pages branch at https://github.com/joostn/OpenJsCad/tree/gh-pages + +The actual CSG engine is in csg.js. Don't fork the copy of csg.js here, but instead create a fork of this branch: +https://github.com/joostn/csg.js + +# License + +Copyright (c) 2012 Joost Nieuwenuijse (joost@newhouse.nl), under the [MIT license](http://www.opensource.org/licenses/mit-license.php). +Copyright (c) 2011 Evan Wallace (http://madebyevan.com/), under the [MIT license](http://www.opensource.org/licenses/mit-license.php).