From eb4bae88c09f4d7ab4481f54493e268982c70fc1 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Thu, 13 Aug 2009 15:43:26 +0100 Subject: [PATCH 1/1] YARRG docs page --- yarrg/web/docs | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 yarrg/web/docs diff --git a/yarrg/web/docs b/yarrg/web/docs new file mode 100644 index 0000000..060f525 --- /dev/null +++ b/yarrg/web/docs @@ -0,0 +1,88 @@ +%# This is part of the YARRG website. YARRG is a tool and website +%# for assisting players of Yohoho Puzzle Pirates. +%# +%# Copyright (C) 2009 Ian Jackson +%# Copyright (C) 2009 Clare Boothby +%# +%# YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). +%# The YARRG website is covered by the GNU Affero GPL v3 or later, which +%# basically means that every installation of the website will let you +%# download the source. +%# +%# This program is free software: you can redistribute it and/or modify +%# it under the terms of the GNU Affero General Public License as +%# published by the Free Software Foundation, either version 3 of the +%# License, or (at your option) any later version. +%# +%# This program is distributed in the hope that it will be useful, +%# but WITHOUT ANY WARRANTY; without even the implied warranty of +%# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +%# GNU Affero General Public License for more details. +%# +%# You should have received a copy of the GNU Affero General Public License +%# along with this program. If not, see . +%# +%# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and +%# are used without permission. This program is not endorsed or +%# sponsored by Three Rings. +%# +%# +%# This Mason component generates the documentation. +%# +YARRG (Yet Another Revenue Research Gatherer) + +

Introduction to YARRG

+YARRG is inspired by PCTB. + +

Obtaining the client

+The current official version of YARRG for use as a client can browsed here: + http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/ + +

+See particularly the +YARRG README. + +

+To install the client, install the `git' version control system +and the other dependencies listed in the `Installation requirements' +section of the README and then run: +

+git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
+cd ypp-sc-tools
+cd yarrg
+make
+
+this will download the code into the directory ypp-sc-tools, +and build the software. + +

+When new versions are released, you can: +

+cd .../ypp-sc-tools
+git-pull
+
+to fetch the new version. + +

Free Software (aka Open Source)

+ +YARRG is Free Software - you may share and modify it. See the +licences for details. + +

+ +Not only the client but also the webserver code is Free. The website +code can be found in the same tree as above, in the web +directory. + +

+ +But in case we have made changes but not yet pushed them +(perhaps because we haven't done a release), and to make it easy for +anyone else who runs a copy of the website to provide everyone with +the source for their version, you can download an up-to-date +tarball of the +actually-running website code. + + + +<& footer &> -- 2.30.2