antialiasing text conversion: dictionary-manager prompting seems to work

[ypp-sc-tools.db-test.git] / pctb / README

diff --git a/pctb/README b/pctb/README
index 231159c2f0a9a0d8f50f22a7adc35dabdd458a3c..4f56fd8ab0d0d9a53e773f804ed8c24386d00548 100644 (file)
--- 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
 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
 
 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.
 
 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.
 
    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
 
  * #master-char*#.txt  #local-char*#.txt
    #master-pixmap#.txt #local-pixmap#.txt
 


@@ -100,6 +120,12 @@ The program reads and writes the following files:
    server.  This is fetched and updated automatically as necessary.
    It can safely be deleted as it will then be refetched.
 
    server.  This is fetched and updated automatically as necessary.
    It can safely be deleted as it will then be refetched.
 

+ * #upload-1#.html #upload-2#.html
+
+   We screenscrape the pages from the PCTB upload server.  The actual
+   HTML returned from the upload server is left in these dropping
+   files for debugging etc.
+

  * <file>.new
 
    When any of these tools overwrite one of the persistent dictionary
  * <file>.new
 
    When any of these tools overwrite one of the persistent dictionary