Initial documentation

diff --git a/pctb/README b/pctb/README
new file mode 100644 (file)
index 0000000..938f0de
--- /dev/null
+++ b/pctb/README
@@ -0,0 +1,18 @@
+This tool can:
+  - screenscrape the commodities trading screen
+  - produce the results as a tab separated values file
+  - **TODO** upload the results to PCTB
+
+To run it, change to this directory, type `make', and then:
+  ./ypp-commodities >commods.csv
+
+It may put up a window asking about characters it does not understand.
+It is important to get these inputs right or it may misrecognise
+things in future.  **TODO** write actual useful instructuions to cover the
+subtleties.  The results are stored in the file `charset-15.txt'.
+
+If you need to report a bug, please be sure to remember the exact
+error message and circumstances.  Also, for recognition problems there
+will probably be a very useful screenshot file called `#pages#.pnm'.
+This is likely to be very large so don't just email it to me, but if
+you can put it up on a webpage for me to download that will help.