chiark / gitweb /
YARRG docs page
[ypp-sc-tools.db-test.git] / yarrg / web / docs
1 %# This is part of the YARRG website.  YARRG is a tool and website
2 %# for assisting players of Yohoho Puzzle Pirates.
3 %#
4 %# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
5 %# Copyright (C) 2009 Clare Boothby
6 %#
7 %#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
8 %#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
9 %#   basically means that every installation of the website will let you
10 %#   download the source.
11 %#
12 %# This program is free software: you can redistribute it and/or modify
13 %# it under the terms of the GNU Affero General Public License as
14 %# published by the Free Software Foundation, either version 3 of the
15 %# License, or (at your option) any later version.
16 %#
17 %# This program is distributed in the hope that it will be useful,
18 %# but WITHOUT ANY WARRANTY; without even the implied warranty of
19 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 %# GNU Affero General Public License for more details.
21 %#
22 %# You should have received a copy of the GNU Affero General Public License
23 %# along with this program.  If not, see <http://www.gnu.org/licenses/>.
24 %#
25 %# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
26 %# are used without permission.  This program is not endorsed or
27 %# sponsored by Three Rings.
28 %#
29 %#
30 %# This Mason component generates the documentation.
31 %#
32 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
33 </head><body>
34 <h1>Introduction to YARRG</h1>
35 YARRG is inspired by PCTB.
36
37 <h1>Obtaining the client</h1>
38 The current official version of YARRG for use as a client can browsed here:
39  <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
40
41 <p>
42 See particularly the
43 <a href="/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
44
45 <p>
46 To install the client, install the `git' version control system
47 and the other dependencies listed in the `Installation requirements'
48 section of the README and then run:
49 <pre>
50 git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
51 cd ypp-sc-tools
52 cd yarrg
53 make
54 </pre>
55 this will download the code into the directory <code>ypp-sc-tools</code>,
56 and build the software.
57
58 <p>
59 When new versions are released, you can:
60 <pre>
61 cd .../ypp-sc-tools
62 git-pull
63 </pre>
64 to fetch the new version.  
65
66 <h1>Free Software (aka Open Source)</h1>
67
68 YARRG is Free Software - you may share and modify it.  See the
69 licences for details.
70
71 <p>
72
73 Not only the client but also the webserver code is Free.  The website
74 code can be found in the same tree as above, in the <code>web</code>
75 directory.
76
77 <p>
78
79 But in case we have made changes but not yet pushed them
80 (perhaps because we haven't done a release), and to make it easy for
81 anyone else who runs a copy of the website to provide everyone with
82 the source for their version, you can download an up-to-date
83 <a href="source.tar.gz">tarball</a> of the
84 actually-running website code.
85
86 </html>
87
88 <& footer &>