diff options
| -rw-r--r-- | README.md | 56 | ||||
| -rw-r--r-- | README.rst | 64 |
2 files changed, 120 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5e96da3 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +Tubular Structures +================== + +This project aims to build a number of useful structures out of easily +sourceable aluminium tubes that easily fit in the boot of a compact car +and custom 3Dprinted joints. + +Already buildable structures include a number of banner stands and +parasols. + +Instructions +------------ + +### Building the 3D models + +To generate the .stl files for each piece you need Make (tested with +[GNU Make](https://www.gnu.org/software/make/)) and +[OpenSCAD](http://www.openscad.org/); one you have installed these +dependencies just run: + + $ make + +from the root directory of this repository and wait. + +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. + +### Assembly + +To assembly most structures you'll need a number of 1m long aluminium +tubes; the models assume that they are 16mm in diameter, but they can be +customized. + +### 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 +------- + +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..d2045af --- /dev/null +++ b/README.rst @@ -0,0 +1,64 @@ +==================== + Tubular Structures +==================== + +This project aims to build a number of useful structures out of +easily sourceable aluminium tubes that easily fit in the boot of +a compact car and custom 3Dprinted joints. + +Already buildable structures include a number of banner stands and +parasols. + +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/ + +Assembly +~~~~~~~~ + +To assembly most structures you'll need a number of 1m long aluminium +tubes; the models assume that they are 16mm in diameter, but they can be +customized. + +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 +------- + +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/. + |