summaryrefslogtreecommitdiff
path: root/openscad/README.md
diff options
context:
space:
mode:
authorAndrew Cady <d@jerkface.net>2019-03-13 01:58:08 -0400
committerAndrew Cady <d@jerkface.net>2019-03-13 01:58:08 -0400
commitee8373d9a9175f5f4f6553b9e253daf62e76610c (patch)
treeadb0201a3245ff0f40b30e52f7e4fbb01c28502f /openscad/README.md
parenteee0ea179902152ed2431adae99a15507eb1fc94 (diff)
bring in OpenSCAD (forward-ported)
Diffstat (limited to 'openscad/README.md')
-rw-r--r--openscad/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/openscad/README.md b/openscad/README.md
new file mode 100644
index 0000000..2a72291
--- /dev/null
+++ b/openscad/README.md
@@ -0,0 +1,28 @@
1# What's Graphics.OpenSCAD
2
3This is a library whose primary component is an algebraic data type
4for describing [OpenSCAD](http://openscad.org) models, and a function
5that converts that data type into a string. There are convenience
6functions to make building the model easier.
7
8## What's different
9
10Given the primitive and quirky nature of the OpenSCAD language, the
11idea of "using OpenSCAD" as an assembler is both obvious, and promoted
12in lieu of adding major extensions to OpenSCAD. So there are a number
13of such projects, for a variety of languages.
14
15Any compiler that generated "assembler" that caused the assembler
16program to generate errors would be considered buggy. However, none of
17the alternative projects I looked at seemed to do anything about that
18(my apologies if I missed one - I only looked at languages I was
19interested in using). Graphics.OpenSCAD takes the attitude that errors
20from OpenSCAD on the generated code are errors in
21Graphics.OpenSCAD. If you manage to generate code that causes OpenSCAD
22to issue an error message, please open an issue here.
23
24## More info
25
26Read the
27[online docs](https://hackage.haskell.org/package/OpenSCAD-0.2.1.0/docs/Graphics-OpenSCAD.html)
28at [hackage](http://hackage.haskell.org/).