X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=blobdiff_plain;f=pctb%2FREADME;h=96914335c7351132b7c955df238de53344d81e37;hp=e9f4f097b06adb1e6fe73a9c4a5a5b34766170a7;hb=d5514a07ad8470e0c00f158ef0a02ff6a90adb22;hpb=a16d3db1d044e2eb62e4d6f4d1db9f2c6fc0713e

diff --git a/pctb/README b/pctb/README
index e9f4f09..9691433 100644
--- a/pctb/README
+++ b/pctb/README
@@ -4,10 +4,12 @@ Overview
 This tool can:
   - screenscrape the commodities trading screen
   - produce the results as a tab separated values file
-  - **TODO** upload the results to PCTB
+  - upload the results to PCTB
 
 To run it, change to this directory, type `make', and then:
   ./ypp-commodities --tsv >commods.tsv
+or
+  ./ypp-commodities --upload
 
 While it is capturing the screenshots, do not move the mouse or use
 the keyboard.  Keyboard focus must stay in the YPP client window.
@@ -75,6 +77,24 @@ The program reads and writes the following files:
    it.  Don't try `display vid:#pages#.pnm' as this will consume
    truly stupendous quantities of RAM - it wedged my laptop.
 
+ * #master-newcommods#.txt #local-newcommods#.txt
+
+   Dictionary of newly introduced commodities.  When a new commodity
+   appears in Puzzle Pirates, the PCTB server operators need to add it
+   to their database for us to be able to upload data about it.
+
+   It can sometimes take a few days to do this.  In the meantime, it
+   is possible to upload partial data - data just omitting that
+   commodity.  This is controlled by these files: they list
+   commodities which should be automatically ignored if the PCTB
+   server doesn't know about them.  The master file is downloaded and
+   updated automatically from my server.  You may create the local
+   file yourself.  The format is simple: one commodity per line.
+
+   Unrecognised commodities can also be due to OCR failure so
+   double-check what you're doing before overriding the uploader by
+   telling it to ignore an unrecognised commodity.
+
  * #master-char*#.txt  #local-char*#.txt
    #master-pixmap#.txt #local-pixmap#.txt
 
@@ -106,10 +126,10 @@ The program reads and writes the following files:
    HTML returned from the upload server is left in these dropping
    files for debugging etc.
 
- * <file>.new
+ * <file>.tmp
 
    When any of these tools overwrite one of the persistent dictionary
-   files, they temporarily write to <file>.new.
+   files, they temporarily write to <file>.tmp.
 
 These files are all in the current working directory.  There is not
 yet any feature to have them be somewhere else.  The helper programs