Update README file
authorH.G. Muller <h.g.muller@hccnet.nl>
Tue, 17 Apr 2012 06:56:39 +0000 (08:56 +0200)
committerH.G. Muller <h.g.muller@hccnet.nl>
Tue, 17 Apr 2012 06:59:01 +0000 (08:59 +0200)
Add description of the debug and -var options.

README.txt

index 026ad8b..578495e 100644 (file)
@@ -16,6 +16,18 @@ and just passes on the moves and position FENs as it receives them from engine o
 As this can be done without any knowledge of the game rules, or even of the board size, \r
 such a dumb adapter can in principle be used for any variant. To use it for UCI protocol\r
 (both the Chess or Xiangqi dialects), use it without the -s flag (or with a -c flag).\r
+  The general syntax of the UCI2WB command is:\r
+\r
+UCI2WB [debug] [-var VARIANTLIST] [-s|-c] ENGINE.exe [ENGINEFOLDER]\r
+\r
+Presence of the 'debug' argument causes UCI2WB to report everything it receives from the engine,\r
+as well as the 'position' and 'go' comamnds sent to it, as debug output (prefixed with '#')\r
+to the GUI. This has the same effect as switching the option 'UCI2WB debug output' on,\r
+except that it forces the option to be on from the very beginning, so that the engine\r
+startup will also be reported.\r
+  The '-var' option overrules the list of variants UCI2WB says it supports with the given list,\r
+like 'feature variants="VARIANTLIST"'.\r
+\r
 \r
 This package includes the source code. To compile on Windows under Cygwin, use the commands\r
 \r
@@ -34,6 +46,9 @@ H.G.Muller
 \r
 Change log:\r
 \r
+17/4/2012\r
+Make supported-variants string configurable from command line.\r
+\r
 15/4/2012 v1.7\r
 Take 30ms safety margin in translating st command to movetime\r
 \r