--- /dev/null
+<%doc>
+
+ 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 introduction.
+
+
+</%doc>
+<html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
+</head><body>
+
+<a href="lookup">YARRG</a> -
+ Yet Another Revenue Research Gatherer
+|
+<b>development</b>
+|
+<a href="intro">introduction</a>
+|
+<a href="docs">documentation</a>
+
+<h1>YARRG development, contribution and troubleshooting</h1>
+
+<h2>Free Software (aka Open Source) licensing</h2>
+
+YARRG is Free Software - you may share and modify it. See the
+licences for details. Not only the client but also the website code
+is Free. The yarrg client, support files, and so forth are under
+the GNU GPL (v3 or later); the website is under the GNU Affero GPL (v3
+or later). </p>
+
+<p>
+
+Note that there is <strong>NO WARRANTY</strong> !
+
+<h2>Resources for developers</h2>
+
+<h3>Source code</h3>
+
+<kbd>git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</kbd><br>
+obtains the source code of the latest release, which you can also find
+<a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as an unpacked tree</a>
+
+<p><a href="source.tar.gz">Live website source code</a> can
+be downloaded, 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, the website code itself lets you download
+an up-to-date of its actually-running source code. So this link
+gives you the source code for the pages you are now looking at.
+
+<h3>YARRG lookup website instances</h3>
+ <ul>
+ <li><a href="http://yarrg.chiark.net/">Main released site</a>
+ <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a>
+ <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>
+ <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a>
+ </ul>
+
+Each of these allows you to download its own source code so you
+can get both the testing and the main version of the website.
+
+<h3>Data</h3>
+
+<kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
+accesses files published for the benefit of the yarrg upload client,
+
+<p>
+
+This directory also contains slightly stale copies (updated daily)
+of the actual databases (in SQLite3 format).
+It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
+but please do not repeatedly download the databases by http - use
+rsync which is much more efficient. Note also that if you want to
+actually run your own improved yarrg website, I can arrange to
+feed you data in real time - see below.
+
+<p>
+
+<kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
+accesses the data for the testing instance.
+
+<h3>Documentation</h3>
+
+<a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
+has the specification of the mechanism and format for uploading to YARRG.
+
+<h2>Support from the YARRG team</h2>
+
+If you would like to run a (perhaps modified) copy of the YARRG
+website it would be very easy for us to make our system send you
+copies of updates submitted by users of the official YARRG client, in
+the format expected by the YARRG code. Please just ask us - it's just
+a matter of us adding your database instance's special email address
+to our alias file.
+
+<p>
+
+We encourage the development and improvement of this code. Please
+continue to share your improvements with the Puzzle Pirates community.
+In particular, do not remove or break the feature that allows users of
+your website to download the up to date code you are running.
+
+<h2>Contacting the YARRG developers</h2>
+
+Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to
+any Fleet Officer or above of the crew Special Circumstances on the
+Midnight Ocean.
+
+<& footer, isdevel => 1 &>
<a href="lookup">YARRG</a> -
Yet Another Revenue Research Gatherer
|
+<a href="devel">development</a>
+|
<b>introduction</b>
|
<a href="docs">documentation</a>
There is not currently an upload client for Windows which feeds data
into YARRG. It would probably be straightforward to modify the
-Windows PCTB v5 upload client to upload to YARRG as well. The
-mechanism and format for uploading is documented in
-<a href="/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>.
-
-<h1>YARRG development, contribution and troubleshooting</h1>
-
-<h2>Free Software (aka Open Source)</h2>
-
-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, the website code itself lets you download
-an up-to-date <a href="source.tar.gz">tarball</a> of its
-actually-running source code.
+Windows PCTB v5 upload client to upload to YARRG as well.
<p>
-If you would like to run a (perhaps modified) copy of the YARRG
-website it would be very easy for us to make our system send you
-copies of updates submitted by users of the official YARRG client, in
-the format expected by the code you'll be running. Please just ask
-us.
+See our <a href="devel">Developers' information</a> page.
<h2>Contacting the YARRG developers</h2>
any Fleet Officer or above of the crew Special Circumstances on the
Midnight Ocean.
-<& footer, isdocs => 1 &>
+<& footer &>
~yarrgweb / ypp-sc-tools.db-live.git / commitdiff