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