aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e4b1dc0
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+=============
+ Miscellanea
+=============
+
+This repository hosts 3D models that have no other specific theme.
+
+Building the 3D models
+~~~~~~~~~~~~~~~~~~~~~~
+
+To generate the .stl files for each piece you need Make (tested with
+`GNU Make`_) and OpenSCAD_; one you have installed these
+dependencies just run::
+
+ $ make
+
+from the root directory of this repository and wait.
+
+.. _`GNU Make`: https://www.gnu.org/software/make/
+.. _OpenSCAD: http://www.openscad.org/
+
+License
+-------
+
+Copyright 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/.
+