X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=0ea31cfcc35a9cb8a79facad29dfee2fb17a04bf;hb=38888dbd9221f97b1886ee545d0113c88432556a;hp=dffdf7f8281e1b2ba040a4bc1360a1bcf8b55ed8;hpb=1e054798d3b98978221871919c52af06464d48f2;p=ypp-sc-tools.web-live.git
diff --git a/yarrg/web/docs b/yarrg/web/docs
index dffdf7f..0ea31cf 100755
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -35,20 +35,35 @@
%doc>
YARRG (Yet Another Revenue Research Gatherer)
-<& webcopyright &>
Introduction to YARRG
-YARRG (Yet Another Revenue Research Gatherer) is inspired by PCTB.
-Results
+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
+PCTB.
+
+
+
+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.
+
+
The lookup page gives access to the uploaded data.
-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/
+Uploading from Linux
+
+The YARRG upload client uploads both to YARRG and to the
+PCTB testing server.
+
+The current official version of YARRG for use as an upload
+client can browsed here:
+ http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/
See particularly the
YARRG README.
@@ -66,14 +81,27 @@ this will download the code into the directory ypp-sc-tools
,
and build the software.
-When new versions are released, you can:
+
+When new versions of the upload client are released, you can:
cd .../ypp-sc-tools
git-pull
+cd yarrg
+make
-to fetch the new version.
+to fetch the new version.
+
+Uploading from Windows
-Free Software (aka Open Source)
+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
+README.devel.
+
+YARRG development, contribution and troubleshooting
+
+Free Software (aka Open Source)
YARRG is Free Software - you may share and modify it. See the
licences for details.
@@ -89,17 +117,22 @@ 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.
+the source for their version, the website code itself lets you download
+an up-to-date tarball of its
+actually-running source code.
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.
+
+
Contacting the YARRG developers
-
+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 &>