From: Ian Jackson Date: Sat, 16 Sep 2023 11:46:19 +0000 (+0100) Subject: Make README into Markdown X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=reprap-play.git;a=commitdiff_plain;h=0537b1e0d1b0b6ea49007a6f158ad7526467d4dc Make README into Markdown Signed-off-by: Ian Jackson --- diff --git a/README b/README index 36ca447..5c5af41 100644 --- a/README +++ b/README @@ -1,22 +1,23 @@ +# Diziet's (Ian Jackson)'s 3D models + This directory contains source code a number of objects of various kinds, and a simple build system. -In general for a simple file FOO.scad you can say `make FOO.stl'. - +In general for a simple file `FOO.scad` you can say `make FOO.stl'. More complicated files contain source code for multiple related parts. The actual objects which might be printed or previewed are indicated -in the source code with `///toplevel'. For a complicated file -BAR.scad you can generate simple template openscad files, one for each -such object, with `make BAR.auto.scads'. And you can make all the -corresponding .stl files with `make BAR.auto.stls'. - +in the source code with `////toplevel`. For a complicated file +`BAR.scad` you can generate simple template openscad files, one for each +such object, with `make BAR.auto.scads`. And you can make all the +corresponding `.stl` files with `make BAR.auto.stls`. -Many objects have `slop' in them, which represents an amount by which +Many objects have "slop" in them, which represents an amount by which holes or gaps are bigger, in order to make things fit well. You will need to examine the openscad source or play around with previews to see which slop does what. +# Copyright Unless otherwise noted every object and file here is: diff --git a/README.md b/README.md new file mode 100644 index 0000000..36ca447 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +This directory contains source code a number of objects of various +kinds, and a simple build system. + +In general for a simple file FOO.scad you can say `make FOO.stl'. + + +More complicated files contain source code for multiple related parts. +The actual objects which might be printed or previewed are indicated +in the source code with `///toplevel'. For a complicated file +BAR.scad you can generate simple template openscad files, one for each +such object, with `make BAR.auto.scads'. And you can make all the +corresponding .stl files with `make BAR.auto.stls'. + + +Many objects have `slop' in them, which represents an amount by which +holes or gaps are bigger, in order to make things fit well. You will +need to examine the openscad source or play around with previews to +see which slop does what. + + +Unless otherwise noted every object and file here is: + + Copyright Ian Jackson + Licenced under the GNU General Public Licence, version 3, or + (at your option) any later version. There is NO WARRANTY. +