yarrg/web/devel

   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 introduction.
  33
  34
  35 </%doc>
  36 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
  37 </head><body>
  38
  39 <a href="lookup">YARRG</a> -
  40  Yet Another Revenue Research Gatherer
  41 |
  42 <b>development</b>
  43 |
  44 <a href="intro">introduction</a>
  45 |
  46 <a href="docs">documentation</a>
  47
  48 <h1>YARRG development, contribution and troubleshooting</h1>
  49
  50 <h2>Free Software (aka Open Source) licensing</h2>
  51
  52 YARRG is Free Software - you may share and modify it.  See the
  53 licences for details.  Not only the client but also the website code
  54 is Free.  The yarrg client, support files, and so forth are under
  55 the GNU GPL (v3 or later); the website is under the GNU Affero GPL (v3
  56 or later).  </p>
  57
  58 <p>
  59
  60 Note that there is <strong>NO WARRANTY</strong> !
  61
  62 <h2>Resources for developers</h2>
  63
  64 <h3>Source code</h3>
  65
  66 <kbd>git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</kbd><br>
  67 obtains the source code of the latest release, which you can also find
  68 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as an unpacked tree</a>
  69
  70 <p><a href="source.tar.gz">Live website source code</a> can
  71 be downloaded, in case we have made changes but not yet pushed them
  72 (perhaps because we haven't done a release), and to make it easy for
  73 anyone else who runs a copy of the website to provide everyone with
  74 the source for their version, the website code itself lets you download
  75 an up-to-date of its actually-running source code.  So this link
  76 gives you the source code for the pages you are now looking at.
  77
  78 <h3>YARRG lookup website instances</h3>
  79  <ul>
  80  <li><a href="http://yarrg.chiark.net/">Main released site</a>
  81  <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a>
  82  <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>
  83  <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a>
  84  </ul>
  85
  86 Each of these allows you to download its own source code so you
  87 can get both the testing and the main version of the website.
  88
  89 <h3>Data</h3>
  90
  91 <kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
  92 accesses files published for the benefit of the yarrg upload client,
  93
  94 <p>
  95
  96 This directory also contains slightly stale copies (updated daily)
  97 of the actual databases (in SQLite3 format).
  98 It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
  99 but please do not repeatedly download the databases by http - use
 100 rsync which is much more efficient.  Note also that if you want to
 101 actually run your own improved yarrg website, I can arrange to
 102 feed you data in real time - see below.
 103
 104 <p>
 105
 106 <kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
 107 accesses the data for the testing instance.
 108
 109 <h3>Documentation</h3>
 110
 111 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
 112 has the specification of the mechanism and format for uploading to YARRG.
 113
 114 <h2>Support from the YARRG team</h2>
 115
 116 If you would like to run a (perhaps modified) copy of the YARRG
 117 website it would be very easy for us to make our system send you
 118 copies of updates submitted by users of the official YARRG client, in
 119 the format expected by the YARRG code.  Please just ask us - it's just
 120 a matter of us adding your database instance's special email address
 121 to our alias file.
 122
 123 <p>
 124
 125 We encourage the development and improvement of this code.  Please
 126 continue to share your improvements with the Puzzle Pirates community.
 127 In particular, do not remove or break the feature that allows users of
 128 your website to download the up to date code you are running.
 129
 130 <h2>Contacting the YARRG developers</h2>
 131
 132 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
 133 any Fleet Officer or above of the crew Special Circumstances on the
 134 Midnight Ocean.
 135
 136 <& footer, isdevel => 1 &>