Readme and license

2 files changed, 111 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9254770
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+Polyhedra and polyhedral dices
+==============================
+
+Instructions
+------------
+
+### Building the 3D models
+
+These files use [OpenSCAD](http://www.openscad.org/) and require Make
+(tested with [GNU Make](https://www.gnu.org/software/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](http://slic3r.org/) 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.
+
+### 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/>.
+
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..9612e7e
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,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/.
+