yarrg/web/docs

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