yarrg/web/docs

   1 %# This is part of the YARRG website.  YARRG is a tool and website
   2 %# for assisting players of Yohoho Puzzle Pirates.
   3 %#
   4 %# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
   5 %# Copyright (C) 2009 Clare Boothby
   6 %#
   7 %#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
   8 %#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
   9 %#   basically means that every installation of the website will let you
  10 %#   download the source.
  11 %#
  12 %# This program is free software: you can redistribute it and/or modify
  13 %# it under the terms of the GNU Affero General Public License as
  14 %# published by the Free Software Foundation, either version 3 of the
  15 %# License, or (at your option) any later version.
  16 %#
  17 %# This program is distributed in the hope that it will be useful,
  18 %# but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 %# GNU Affero General Public License for more details.
  21 %#
  22 %# You should have received a copy of the GNU Affero General Public License
  23 %# along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 %#
  25 %# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
  26 %# are used without permission.  This program is not endorsed or
  27 %# sponsored by Three Rings.
  28 %#
  29 %#
  30 %# This Mason component generates the documentation.
  31 %#
  32 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
  33 </head><body>
  34
  35 <h1>Introduction to YARRG</h1>
  36 YARRG (Yet Another Revenue Research Gatherer) is inspired by PCTB.
  37
  38 <h1>Results</h1>
  39
  40 The <a href="lookup">lookup page</a> gives access to the uploaded data.
  41
  42 <h1>Obtaining the client</h1>
  43 The current official version of YARRG for use as a client can browsed here:
  44  <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
  45
  46 <p>
  47 See particularly the
  48 <a href="/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
  49
  50 <p>
  51 To install the client, install the `git' version control system
  52 and the other dependencies listed in the `Installation requirements'
  53 section of the README and then run:
  54 <pre>
  55 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
  56 cd ypp-sc-tools
  57 cd yarrg
  58 make
  59 </pre>
  60 this will download the code into the directory <code>ypp-sc-tools</code>,
  61 and build the software.
  62
  63 <p>
  64 When new versions are released, you can:
  65 <pre>
  66 cd .../ypp-sc-tools
  67 git-pull
  68 </pre>
  69 to fetch the new version.
  70
  71 <h1>Free Software (aka Open Source)</h1>
  72
  73 YARRG is Free Software - you may share and modify it.  See the
  74 licences for details.
  75
  76 <p>
  77
  78 Not only the client but also the webserver code is Free.  The website
  79 code can be found in the same tree as above, in the <code>web</code>
  80 directory.
  81
  82 <p>
  83
  84 But in case we have made changes but not yet pushed them
  85 (perhaps because we haven't done a release), and to make it easy for
  86 anyone else who runs a copy of the website to provide everyone with
  87 the source for their version, you can download an up-to-date
  88 <a href="source.tar.gz">tarball</a> of the
  89 actually-running website code.
  90
  91 <p>
  92
  93 If you would like to run a (perhaps modified) copy of the YARRG
  94 website it would be very easy for us to send you copies of updates
  95 submitted by users of the official YARRG client, in the format
  96 expected by the code you'll be running.  Please just ask us.
  97
  98 </html>
  99
 100 <& footer &>