Make README into Markdown

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/README b/README
index 36ca447f5b52219105e774760a47e68e5ec48767..5c5af4170834c60bce5bd2c7376512cc0bc294b8 100644 (file)
--- 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 (file)
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.
+