aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 9612e7e28448efaf4b4d2f653f881224aa56fb47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
================================
 Polyhedra and polyhedral dices
================================

Instructions
------------

Building the 3D models
~~~~~~~~~~~~~~~~~~~~~~

These files use OpenSCAD_ and require Make (tested with `GNU Make`_)
for automated building.

Various examples are provided in the ``designs`` directory: to generate
.stl files for one of them run::

   $ make build/<design_name>.stl

or generate all of the available designs with::

   $ make

Example settings for Slic3r_ are available in the conf directory: 
you can load them in Slic3r, change the settings (expecially those 
related to the printer) and re-export them in place. 
Then you can use::

   $ make gcode

from the root directory of the repository to generate .gcode files 
which can be sent to your printer.

.. _`GNU Make`: https://www.gnu.org/software/make/
.. _OpenSCAD: http://www.openscad.org/
.. _Slic3r: http://slic3r.org/

Using the library
~~~~~~~~~~~~~~~~~

TBD

Readme
~~~~~~

The file README.md is generated from README.rst with::

   pandoc -o README.md README.rst

and is included in the repo for the benefit of gitorious.

License
-------

OpenSCAD code and SVG artwork Copyright 2013-2014 Elena Grandi

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
International License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/4.0/.