diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2016-07-23 14:36:06 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2016-07-23 14:36:06 +0200 |
| commit | 9465ca5b6adc32f81c5e0ab5038a427a43c0390f (patch) | |
| tree | 1700d5fb0add48d0a9652075356679214ac5e654 | |
| parent | 1d0f3df3f8a582f637adcf6da5673d36e5f11a4d (diff) | |
Basic readme
| -rw-r--r-- | README.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d1fe9d4 --- /dev/null +++ b/README.rst @@ -0,0 +1,48 @@ +============= + Craft Tools +============= + +This repository hosts 3D models for a number of tools used in various +crafts, including: + +* net making +* lucet +* sewing + +Instructions +------------ + +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. + +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/ + +License +------- + +Copyright 2015-2016 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/. + |