diff options
| -rw-r--r-- | README.md | 63 | ||||
| -rw-r--r-- | README.rst | 9 |
2 files changed, 72 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5300507 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +3D Printable Piecepack +====================== + +The [piecepack](http://www.piecepack.org/) is a generic set of boardgame +parts designed by James Kyle and released under public domain. Hundreds +of games for the piecepack are available on the internet, both on the +official site and on the [piecepack +wiki](http://www.ludism.org/ppwiki/). + +This piecepack is designed for 3D printers and can be printed at home +(or your local fablab) or sent to a 3D printing service. Currently it +includes the piecepack (with saucers and suite die), in basic and cards +variants, while the seasons extensions is planned for the future. + +Instructions +------------ + +### Building the 3D models + +To generate the .stl files for each piecepack component 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. + +### Printing + +The models should be printed in an opaque material: when using PLA a +darkish color may be better than a light one. + +All markings on the pieces are recessed in the surface and should be +painted with appropriate colors. On PLA I've used craft acrylics with +success by applying two layers of primer. + +### 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 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/>. @@ -54,6 +54,15 @@ All markings on the pieces are recessed in the surface and should be painted with appropriate colors. On PLA I've used craft acrylics with success by applying two layers of primer. +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 ------- |