chiark / gitweb /
Make README into Markdown
[reprap-play.git] / README
1 # Diziet's (Ian Jackson)'s 3D models
2
3 This directory contains source code a number of objects of various
4 kinds, and a simple build system.
5
6 In general for a simple file `FOO.scad` you can say `make FOO.stl'.
7
8 More complicated files contain source code for multiple related parts.
9 The actual objects which might be printed or previewed are indicated
10 in the source code with `////toplevel`.  For a complicated file
11 `BAR.scad` you can generate simple template openscad files, one for each
12 such object, with `make BAR.auto.scads`.  And you can make all the
13 corresponding `.stl` files with `make BAR.auto.stls`.
14
15 Many objects have "slop" in them, which represents an amount by which
16 holes or gaps are bigger, in order to make things fit well.  You will
17 need to examine the openscad source or play around with previews to
18 see which slop does what.
19
20 # Copyright
21
22 Unless otherwise noted every object and file here is:
23
24   Copyright Ian Jackson
25   Licenced under the GNU General Public Licence, version 3, or
26   (at your option) any later version.  There is NO WARRANTY.
27