chiark / gitweb /
c21ffa2b3f5177359ffaf9ab003ea2059f18792e
[ypp-sc-tools.web-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 <& docshead &>
37 <h1>YARRG development, contribution and troubleshooting</h1>
38
39 <h2>Free Software (aka Open Source) licensing</h2>
40
41 YARRG is Free Software - you may share and modify it.  See the
42 licences for details.  Not only the client but also the website code
43 is Free.  The yarrg client, support files, and so forth are under the
44 GNU GPL (v3 or later); the website and database backend is under the
45 GNU Affero GPL (v3 or later).
46
47 <p>
48
49 Note that there is <strong>NO WARRANTY</strong> !
50
51 <h2>Resources for developers</h2>
52
53 <h3>Source code</h3>
54
55 <kbd>git clone git://git.yarrg.chiark.net/ypp-sc-tools.main.git</kbd><br>
56 clones the master tree through which we push most changes.
57 <p>
58
59 <kbd>git clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git/</kbd><br>
60 obtains the source code of the latest version released for use as a
61 screenscraper client, which you can also find
62 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/">as
63 an unpacked tree</a>
64
65 <p><a href="source.tar.gz">Live website source code</a> can
66 be downloaded:  In case we have made changes but not yet pushed them
67 (perhaps because we haven't done a release), and to make it easy for
68 anyone else who runs a copy of the website to provide everyone with
69 the source for their version, the website code itself lets you download
70 an up-to-date of its actually-running source code.  So this link
71 gives you the source code for the pages you are now looking at.
72
73 <p>All of the above trees are available via the
74 <a href="http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git">gitweb
75 source code and history browser</a>.
76
77 <h4>Uploader</h4>
78
79 The uploader is also Free Software, but under a slightly different
80 licence.  The <a href="upload">uploader page</a> has
81 <a href="upload#source">complete information on how to get its source code</a>.
82
83 <h3>YARRG website code instances</h3>
84
85 <h4>Lookup website</h4>
86  <ul>
87  <li><a href="http://yarrg.chiark.net/">Main released site</a>,
88      with <a href="http://yarrg.chiark.net/source.tar.gz">source code</a> (and
89    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-live.git">committed changes via git</a>)
90  <li><a href="http://yarrg.chiark.net/test/data">Released code; testing database instance (updated with yarrg --test-servers)</a> (source code as above)
91  <li><a href="http://yarrg.chiark.net/test/code">Testing version of the site code</a>,
92      with <a href="http://yarrg.chiark.net/test/code/source.tar.gz">source code</a> (and
93    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.web-test.git">committed changes via git</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> including uncommitted changes; or
112    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-live.git">committed changes via git</a>
113  <li><a href="http://upload.yarrg.chiark.net/test/commod-update-receiver?get_source=1">Testing database instance</a> including uncommitted changes; or
114    <a href="git://git.yarrg.chiark.net/ypp-sc-tools.db-test.git">committed changes via git</a>
115  </ul>
116
117 <h3>Data</h3>
118
119 <kbd>rsync rsync.yarrg.chiark.net::yarrg/</kbd><br>
120 accesses files published for the benefit of the old yarrg upload client
121 and other members of the ypp-sc-tools family.
122
123 <p>
124
125 This directory also contains slightly stale copies (updated daily)
126 of the actual databases (in SQLite3 format).
127 It is <a href="http://yarrg.chiark.net/RSYNC/">also available by http</a>
128 but please do not repeatedly download the databases by http - use
129 rsync which is much more efficient.  Note also that if you want to
130 actually run your own improved yarrg website, I can arrange to
131 feed you data in real time - see below.
132
133 <p>
134
135 <kbd>rsync rsync.yarrg.chiark.net::yarrg/test/</kbd><br>
136 accesses the data for the testing instance.
137
138 <h3>Documentation</h3>
139
140 <a href="http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>
141 has the specification of the mechanism and format for uploading to YARRG.
142
143 <h2>Support from the YARRG team</h2>
144
145 If you would like to run a (perhaps modified) copy of the YARRG
146 website it would be very easy for us to make our system send you
147 copies of updates submitted by users of the YARRG clients including
148 YARRG JPCTB, in the format expected by the YARRG code.  Please just
149 ask us - at our end it's just a matter of us adding your database
150 instance's special email address to our alias file.
151
152 <p>
153
154 We encourage the development and improvement of this code.  Please
155 continue to share your improvements with the Puzzle Pirates community.
156 In particular, do not remove or break the feature that allows users of
157 your website to download the up to date code you are running.
158
159 <h2>Contacting the YARRG developers</h2>
160
161 Email Ian Jackson ijackson (at) chiark.greenend.org.uk.  Or talk to
162 any Fleet Officer or above of the crew Special Circumstances on the
163 Midnight Ocean.
164
165 <p>
166 </div>
167 <& footer, isdevel => 1 &>