X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=blobdiff_plain;f=pctb%2FREADME;h=8379208a4e7319ef1e0c7481c8c4751405040439;hp=59a3646591e7fa2f4f1e869c71302f87d8a76b2a;hb=ca2598d063219f019ba8e04a4762552f556795ca;hpb=124bfe502b5841d6d05f3f7e9fc825f918d3109d

diff --git a/pctb/README b/pctb/README
index 59a3646..8379208 100644
--- a/pctb/README
+++ b/pctb/README
@@ -6,17 +6,22 @@ This tool can:
   - produce the results as a tab separated values file
   - upload the results to PCTB
 
-To run it, change to this directory, type `make', and then:
-  ./ypp-commodities --upload
-to upload to the PCTB server.   Currently we use pctb.ilk.org,
-the testing instance of the PCTB database, pending approval from the
-operators of the main server.
+To build, install the dependencies, cd to this directory and type `make'.
+
+To screenscrape and upload to the PCTB server, select `trade
+commodities' from the hold of a vessel or building, and run:
+   ./ypp-commodities
+Currently we use pctb.ilk.org, the testing instance of the PCTB
+database, pending approval from the operators of the main server.
 
 Or, for example, for a tab-separated values dump:
-  ./ypp-commodities --tsv >commods.tsv
+   ./ypp-commodities --tsv >commods.tsv
 
 While it is capturing the screenshots, do not move the mouse or use
 the keyboard.  Keyboard focus must stay in the YPP client window.
+If you use Gnome or KDE you must raise the YPP client window so that
+it is completely unobscured - the ypp-commodities program tries to do
+this but metacity and kwin do not honour the request.
 
 
 Command-line options
@@ -64,6 +69,8 @@ Or set the environment variables YPPSC_PCTB{_PCTB, _DICT_UPDATE, _DICT_SUBMIT}
 Installation requirements
 -------------------------
 
+Your X server must be 24bpp (or better).
+
 This program has quite a few dependencies:
 							Package (Debian etch)
 
@@ -135,6 +142,47 @@ GUI.
 See README.privacy for full details.
 
 
+Authorship and copyright
+------------------------
+
+The PCTB server itself is a project of Joel Lord and various others.
+
+
+However, this screenscraper and upload client was written entirely
+from scratch by me, Ian Jackson.  It is part of ypp-sc-tools, a set of
+third-party tools for assisting players of Yohoho Puzzle Pirates.
+
+ypp-sc-tools is
+Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU 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 General Public License for more details.
+
+You should have received a copy of the GNU 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.
+
+
+The character and UI images copied from the YPP client, and submitted
+to stored and shared by the YPP SC PCTB dictionary server, are those
+provided by Three Rings as part of the YPP client and by your Java
+installation.  I regard the current use of these images in this way as
+Fair Dealing (in the UK) or Fair Use (in the USA).
+
+These images do not form part of the ypp-sc-tools distribution,
+although the ypp-sc-tools pctb client does download them automatically
+from my dictionary server when run in the most ordinary way.
+
 
  - Ian Jackson
    ijackson@chiark.greenend.org.uk