chiark / gitweb /
Copyright licenses and legal information, and README.
[pandemic-rising-tide.git] / README
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..da939af
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+Introduction
+------------
+
+This repository contains a program to generate a new board for
+Pandemic Rising Tide.  The board is gameplay-identical to the
+original, but the graphics are entirely abstracted and the board is
+intended to be easier to play on.
+
+
+Use
+---
+
+`make' will generate[1] many PostScript and PDF files.  You probably
+want to use the PDFs.  Specifically:
+
+If you have a printer capable of A3:
+
+    board-pa3-bPageB.pdf         on A4
+    board-pa3-bPageMT.pdf        on A3
+
+If you have a printer capable of A4:
+
+    pa4-bPageB               }  print one
+    pa4-bPageM               }    of each
+    pa4-bPageT               }      on A4
+
+If you have a printer capable of A1 and want something you can fold in
+three to paste onto a Z-shaped board to fit into the original A4 box:
+
+   pa1m-bPageP               on A1, and cut at the indicated marks
+
+If you have a printer capable of A1 and don't need that slight size
+reduction:
+
+   pa1-bPageP                on A1, and cut at the indicated marks
+
+If you are in the US and can't print on sensible international paper
+sizes, read this
+  https://www.cl.cam.ac.uk/~mgk25/iso-paper.html
+and feel free to send me patches.
+
+
+[1] Dependencies
+-----------------
+
+You will, notably, need a working copy of plag-mangler, which is a
+planar graph manipulation and layout program I wrote for this project.
+  https://www.chiark.greenend.org.uk/~ianmdlvl/plag-mangler/
+
+It has, in turn, quite a few dependencies.
+
+The other direct dependencies of this repository should be readily
+available on your distro.
+
+
+Legal information
+-----------------
+
+Overall, this is very probably copyright (C) 2017 Z-Man Games
+and definitely copyright (C) 2019 Ian Jackson.
+
+Please see the individual source files for their licenses.
+
+There is NO WARRANTY.