--- /dev/null
+%# This is part of the YARRG website. YARRG is a tool and website
+%# for assisting players of Yohoho Puzzle Pirates.
+%#
+%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+%# Copyright (C) 2009 Clare Boothby
+%#
+%# YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+%# The YARRG website is covered by the GNU Affero GPL v3 or later, which
+%# basically means that every installation of the website will let you
+%# download the source.
+%#
+%# This program is free software: you can redistribute it and/or modify
+%# it under the terms of the GNU Affero General Public License as
+%# published by the Free Software Foundation, either version 3 of the
+%# License, or (at your option) any later version.
+%#
+%# This program is distributed in the hope that it will be useful,
+%# but WITHOUT ANY WARRANTY; without even the implied warranty of
+%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+%# GNU Affero General Public License for more details.
+%#
+%# You should have received a copy of the GNU Affero General Public License
+%# along with this program. If not, see <http://www.gnu.org/licenses/>.
+%#
+%# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+%# are used without permission. This program is not endorsed or
+%# sponsored by Three Rings.
+%#
+%#
+%# This Mason component generates the documentation.
+%#
+<html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
+</head><body>
+<h1>Introduction to YARRG</h1>
+YARRG is inspired by PCTB.
+
+<h1>Obtaining the client</h1>
+The current official version of YARRG for use as a client can browsed here:
+ <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
+
+<p>
+See particularly the
+<a href="/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
+
+<p>
+To install the client, install the `git' version control system
+and the other dependencies listed in the `Installation requirements'
+section of the README and then run:
+<pre>
+git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
+cd ypp-sc-tools
+cd yarrg
+make
+</pre>
+this will download the code into the directory <code>ypp-sc-tools</code>,
+and build the software.
+
+<p>
+When new versions are released, you can:
+<pre>
+cd .../ypp-sc-tools
+git-pull
+</pre>
+to fetch the new version.
+
+<h1>Free Software (aka Open Source)</h1>
+
+YARRG is Free Software - you may share and modify it. See the
+licences for details.
+
+<p>
+
+Not only the client but also the webserver code is Free. The website
+code can be found in the same tree as above, in the <code>web</code>
+directory.
+
+<p>
+
+But in case we have made changes but not yet pushed them
+(perhaps because we haven't done a release), and to make it easy for
+anyone else who runs a copy of the website to provide everyone with
+the source for their version, you can download an up-to-date
+<a href="source.tar.gz">tarball</a> of the
+actually-running website code.
+
+</html>
+
+<& footer &>
~yarrgweb / ypp-sc-tools.web-live.git / commitdiff