chiark / gitweb /
Better usage instructions
authorIan Jackson <ian@liberator.relativity.greenend.org.uk>
Sun, 5 Jul 2009 17:21:28 +0000 (18:21 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Sun, 5 Jul 2009 17:21:28 +0000 (18:21 +0100)
pctb/README

index 2c3a917..8379208 100644 (file)
@@ -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
-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