X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2FREADME;h=10555f47aa039121c0881af27ee8f5c01906692a;hb=217ac850a0e5cca6b2eb24d30ac443d263912e4f;hp=9b594591c40721d4bbb3d013619140cf20c89d1b;hpb=6aa865d00da61a2cf187d85dd605df6b4608fd70;p=ypp-sc-tools.db-live.git diff --git a/yarrg/README b/yarrg/README index 9b59459..10555f4 100644 --- a/yarrg/README +++ b/yarrg/README @@ -4,7 +4,7 @@ YARRG - Yet Another Revenue Research Gatherer Overview -------- -This tool can: +This tool will: - screenscrape the commodities trading screen - produce the results as a tab separated values file - upload the results to the YARRG and PCTB servers @@ -14,9 +14,8 @@ To build, install the dependencies, cd to this directory and type `make'. To screenscrape and upload to both servers, select `trade commodities' from the hold of a vessel or building, and run: ./yarrg -Currently we upload to the dedicated yarrg server yarrg.chiark.net, -and also to pctb.ilk.org (the testing instance of the PCTB database, -pending approval from the operators of the main server). +We upload to the dedicated yarrg server http://yarrg.chiark.net/, +and also to the PCTB server http://pctb.crabdance.com/. Or, for example, for a tab-separated values dump: ./yarrg --tsv >commods.tsv @@ -49,12 +48,14 @@ Options to vary the processing: --test-servers Set default servers to be the test servers, not the real live ones (doesn't affect explicit settings). -Controlling what happens to the results - only one at a time: - --upload (default) Upload to the YARRG and PCTB servers - --tsv Print data as clean tab-separated-values file - --raw-tsv Dump the raw (not deduped, unsorted) OCR'd data - --best-prices Print best buy and sell price for each commodity - --arbitrage Print arbitrage opportunities +Controlling what happens to the results - one or more: + --upload (default) Upload to both the YARRG and PCTB servers + --upload-pctb Upload to the PCTB servers + --upload-yarrg Upload to the YARRG servers + --tsv Print data as clean tab-separated-values file + --raw-tsv Dump the raw (not deduped, unsorted) OCR'd data + --best-prices Print best buy and sell price for each commodity + --arbitrage Print arbitrage opportunities Privacy options, which control conversations with the dictionary server: --dict-local-only * Do not talk to the server even to fetch new dictionary. @@ -95,7 +96,7 @@ This program has quite a few dependencies: On other Linux distros the packages may have different names, but these should be roughly right for Debian and its derivatives. You can install them with this rune: - sudo apt-get install build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl + sudo apt-get install git-core build-essential libnetpbm10-dev netpbm libx11-dev libxtst-dev libpcre3-dev tk8.4 libxml-parser-perl libjson-perl The supplied helper programs @@ -177,7 +178,8 @@ Copyright (C) 2009 Steve Early This program is free software: you can redistribute it and/or modify it under the terms of - (a) for the website code, the GNU Affero General Public License and + (a) for the website code including the route searcher, + the GNU Affero General Public License and (b) for the rest of the code, GNU General Public License as published by the Free Software Foundation, either version 3 of each applicable the License, or (at your option) any later version.