-%# 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 <ijackson@chiark.greenend.org.uk>
-%# 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 <http://www.gnu.org/licenses/>.
-%#
-%# 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.
-%#
+<%doc>
+
+ 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 <ijackson@chiark.greenend.org.uk>
+ 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 <http://www.gnu.org/licenses/>.
+
+ 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.
+
+
+</%doc>
<html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
</head><body>
<& webcopyright &>
<h1>Introduction to YARRG</h1>
-YARRG (Yet Another Revenue Research Gatherer) is inspired by PCTB.
-<h1>Results</h1>
+YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
+for helping find profitable trades and trade routes in Yohoho Puzzle
+Pirates. It was inspired by
+<a href="http://pctb.crabdance.com/">PCTB</a>.
+
+<p>
+
+The system has two main parts: this website which maintains a
+searchable database of commodity prices, and an upload client, which
+screenscrapes the commodity data from the Puzzle Pirates game client
+and uploads it to the database.
+
+<h2><a href="lookup">Market prices database</a></h2>
The <a href="lookup">lookup page</a> gives access to the uploaded data.
-<h1>Obtaining the client</h1>
-The current official version of YARRG for use as a client can browsed here:
- <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
+<h2>Uploading from Linux</h2>
+
+The YARRG upload client uploads both to YARRG and to the
+<a href="pctb.ilk.org">PCTB testing server</a>.
<p>
+
+The current official version of YARRG for use as an upload
+client can browsed here:
+ <a href="/~ijackson/ypp-sc-tools/master/">http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/</a>
See particularly the
<a href="/~ijackson/ypp-sc-tools/master/yarrg/README">YARRG README</a>.
and build the software.
<p>
-When new versions are released, you can:
+
+When new versions of the upload client are released, you can:
<pre>
cd .../ypp-sc-tools
git-pull
+cd yarrg
+make
</pre>
-to fetch the new version.
+to fetch the new version.
+
+<h2>Uploading from Windows</h2>
-<h1>Free Software (aka Open Source)</h1>
+There is not currently an upload client for Windows which feeds data
+into YARRG. It would probably be straightforward to modify the
+Windows PCTB v5 upload client to upload to YARRG as well. The
+mechanism and format for uploading is documented in
+<a href="/~ijackson/ypp-sc-tools/master/yarrg/README.devel">README.devel</a>.
+
+<h1>YARRG development, contribution and troubleshooting</h1>
+
+<h2>Free Software (aka Open Source)</h2>
YARRG is Free Software - you may share and modify it. See the
licences for details.
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
-<a href="source.tar.gz">tarball</a> of the
-actually-running website code.
+the source for their version, the website code itself lets you download
+an up-to-date <a href="source.tar.gz">tarball</a> of its
+actually-running source code.
<p>
If you would like to run a (perhaps modified) copy of the YARRG
-website it would be very easy for us to send you copies of updates
-submitted by users of the official YARRG client, in the format
-expected by the code you'll be running. Please just ask us.
+website it would be very easy for us to make our system send you
+copies of updates submitted by users of the official YARRG client, in
+the format expected by the code you'll be running. Please just ask
+us.
+
+<h2>Contacting the YARRG developers</h2>
-</html>
+Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to
+any Fleet Officer or above of the crew Special Circumstances on the
+Midnight Ocean.
<& footer, isdocs => 1 &>
~yarrgweb / ypp-sc-tools.web-live.git / blobdiff