chiark / gitweb /
WIP improve intro etc. - howto page from Naath
[ypp-sc-tools.main.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 <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 the
60 GNU GPL (v3 or later); the website and database backend is under the
61 GNU Affero GPL (v3 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 website code instances</h3>
86
87 <h4>Lookup website</h4>
88  <ul>
89  <li><a href="http://yarrg.chiark.net/">Main released site</a>,
90      with <a href="http://yarrg.chiark.net/source.tar.gz">source code</a>
91  <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a> (source code as above)
92  <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>,
93      with <a href="http://yarrg.chiark.net/test/code/source.tar.gz">source code</a>
94  <li><a href="http://yarrg.chiark.net/test/both">Testing code running against the testing database instance</a> (source code as above)
95  </ul>
96
97 <p>
98
99 You can add the form parameter <kbd>?debug=1</kbd> to each of the
100 website URLs above to get a version of the site with debugging output enabled.
101
102 <h4>Database and dictionary update receiver</h4>
103
104 On the live system there are different trees, potentially with
105 different versions, for receiving updates and managing the database,
106 to the ones for displaying the website.  The database management trees
107 are normally accessed only via the upload client but you may also
108 download their source directly:
109
110  <ul>
111  <li><a href="http://upload.yarrg.chiark.net/commod-update-receiver?get_source=1">Main production instance</a>
112  <li><a href="http://upload.yarrg.chiark.net/test/commod-update-receiver?get_source=1">Testing database instance</a>
113  </ul>
114
115 <h3>Data</h3>
116
117 <kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
118 accesses files published for the benefit of the yarrg upload client,
119
120 <p>
121
122 This directory also contains slightly stale copies (updated daily)
123 of the actual databases (in SQLite3 format).
124 It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
125 but please do not repeatedly download the databases by http - use
126 rsync which is much more efficient.  Note also that if you want to
127 actually run your own improved yarrg website, I can arrange to
128 feed you data in real time - see below.
129
130 <p>
131
132 <kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
133 accesses the data for the testing instance.
134
135 <h3>Documentation</h3>
136
137 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
138 has the specification of the mechanism and format for uploading to YARRG.
139
140 <h2>Support from the YARRG team</h2>
141
142 If you would like to run a (perhaps modified) copy of the YARRG
143 website it would be very easy for us to make our system send you
144 copies of updates submitted by users of the official YARRG client, in
145 the format expected by the YARRG code.  Please just ask us - at our
146 end it's just a matter of us adding your database instance's special
147 email address to our alias file.
148
149 <p>
150
151 We encourage the development and improvement of this code.  Please
152 continue to share your improvements with the Puzzle Pirates community.
153 In particular, do not remove or break the feature that allows users of
154 your website to download the up to date code you are running.
155
156 <h2>Contacting the YARRG developers</h2>
157
158 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
159 any Fleet Officer or above of the crew Special Circumstances on the
160 Midnight Ocean.
161
162 </div>
163 <& footer, isdevel => 1 &>