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