Initial commit

1 files changed, 52 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0728607
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Connect the dots
+
+This repository houses some "connect the dots" pictures with Christian themes.
+
+## Downloading
+
+If you try to download the SVG files using a web browser, they can break due to
+the way browser handles them.  In this case, you should instead download the ZIP
+archive with all the files in it or use a command line tool, e.g.
+
+```shell-script
+    wget 'https://git.koszko.org/connect-the-dots/plain/cup-of-passion.svg' \
+        -O ./cup-of-passion.svg
+```
+
+## Drawing workflow
+
+Pictures here are initially sketched with pencil and paper.  They are then
+scanned and opened with [Inkscape](https://inkscape.org/).  The actual vector
+image gets drawn over the initial sketch (in a separate Inkscape layer).
+
+Every drawing includes a line (an open sequence of connected segments, without
+curves) named (inside Inkscape) as "connect-the-dots".  This repository contains
+a [GNU Guile](https://www.gnu.org/software/guile/) script `make-points.scm`
+which is then used to add dots with labels on the corners of the line.  Sample
+invokation of the script (under a UNIX-like system with Guile installed) looks
+like this:
+
+```shell-script
+    ./make-points.scm                    \
+        --input=cup-of-passion.svg       \
+        --output=cup-of-passion-work.svg \
+        --font-size=12.5
+```
+
+The modified image is then opened in Inkscape again and the labels are manually
+rearranged to collide with each other and with other picture elements as little
+as possible.  It is still possible to remove a corner and its label at this
+point.  Subsequent invokation of `make-points.scm` on the modified picture
+replaces the dots with new ones and renumbers those labels that have not been
+removed.  The labels remain in the positions they were moved to by the designer.
+
+The final picture can be exported (e.g. to a PDF) after setting sketch and line
+layers to invisible in Inkscape.
+
+## Copying
+
+(Ć) All rights reversed
+
+The contents of this repository are available under the [Creative Commos Zero
+v1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode.pl) license.
+The repository follows the [REUSE](https://reuse.software/) v3.0 specification.