Beginnings of installer for 4.4.0. HGM asked me to forward the nsi file,
[xboard.git] / winboard / install / files / root / PSWBTM / doc / running.html
diff --git a/winboard/install/files/root/PSWBTM/doc/running.html b/winboard/install/files/root/PSWBTM/doc/running.html
new file mode 100644 (file)
index 0000000..4ae1a4a
--- /dev/null
@@ -0,0 +1,106 @@
+<html>\r
+<header>\r
+<title>WGP: Running a Tournament with PSWBTM</title>\r
+</header>\r
+<body>\r
+<table cellpadding="20"><tr><td>\r
+<h1>The WinBoard Gold Pack 4.4.0</h1>\r
+<h2>For the ultimate WinBoard experience!</h2>\r
+</td><td>\r
+<img src="../../WinBoard/doc/mini.gif">\r
+</td></tr></table>\r
+<h3>Using PSWBTM to run an Engine</h3>\r
+<p>\r
+The PSWBTM software basically consists of a single application file, PSWBTM.exe,\r
+located in the PSWBTM folder of te WinBoard Gold Pack. \r
+Just double-click it to run PSWBTM.\r
+The PSWBTM main window that pops up consists of a menu bar with "File", "Tools" and "Help" menu,\r
+and below it an area with 4 selectable displays, \r
+"Pairings", "Standings", "Control" and "Details".\r
+</p>\r
+<img src="menu.png">\r
+<p>\r
+The first step in using PSWBTM is configuring it. \r
+Basically, this only means you have to tell it where it can find WinBoard. \r
+The WinBoard Gold Pack comes with PSWBTM already configured, so you only have \r
+to perform this step if you moved the WinBoard or PSWBTM folders around or renamed them.\r
+How you would have to do that is described <a href="configure.html">here</a>.\r
+</p>\r
+<p>\r
+The next step is to use PSWBTM's engine-manager function to install some engines in the database. \r
+Here also the WinBoard Gold Pack comes with some engines pre-installed\r
+(if you haven't altered the folder structure).\r
+Nevertheless, we first invoke the engine manager to see if they are OK.\r
+This is what you would also do when you wanted to play a Human-engine game against an already installed engine,\r
+or use your engine in over-the-board tournaments as human operator.\r
+</p>\r
+<h3>Running a Single Engine through the Engine Manager</h3>\r
+<p>\r
+Select the menu "Tools -> Engine Manager". \r
+This makes the engine-manager window pop up.\r
+On the left you will see the list of names of all installed engines,\r
+by the names that the user has given them.\r
+In the distribution these are only two engines pre-installed, CPW and Fairy-Max.\r
+(CPW is installed in two different ways, though, so you see three entries.)\r
+Left-click one of the engines in this list (say Fairy-Max) to select it.\r
+This highlights this engine in blue,\r
+while the details of how it is installed appear in the three text lines on the upper right.\r
+Don't bother with these lines yet,\r
+but left-click the button "Launch Engine".\r
+This will invoke WinBoard with this engine,\r
+so you can play a game against it, or have it play itself.\r
+At this point you are in the same position as when you started WinBoard through a shortcut for running this engine,\r
+or when you would have started through the WinBoard startup dialog,\r
+entering all the engine details there by yourself.\r
+PSWBTM has done all this for you,\r
+taking the egine details from the engine-anager database.\r
+</p>\r
+<img src="eman.png">\r
+<p>\r
+You can now <a href="..\..\WinBoard\doc\.html">customize WinBoard</a> through its own menus,\r
+so that the display looks like you want to have it,\r
+(size, colors),\r
+the proper auxiliary windows are up and\r
+correctly sized and positioned,\r
+adjudication options are set as you intend to use them,\r
+select a GUI book, engine hash-table sizes,\r
+etc.\r
+WinBoard will remember almost everything you do here,\r
+and come up the next time exactly as you left it this time.\r
+Only transient WinBoard options,\r
+like the Chess variant,\r
+will be forgotten and start at their default value next time.\r
+So you can safely play a game of Gothic Chess or Knightmate against Fairy-Max now,\r
+that won't affect future operation.\r
+</p><p>\r
+Once you are satisfied with the WinBoard settings,\r
+and perhaps have played a game or had the engine play itself,\r
+you simply quit WinBoard (e.g. by closing its window),\r
+and this will return you to the task manager.\r
+You could now select another engine, and launch that,\r
+or quit the engine manager by clicking the "Exit" button at the bottom.\r
+</p>\r
+<h3>Links</h3>\r
+<p>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=".html"></a>\r
+</br>\r
+<a href=""></a>\r
+</br>\r
+<a href=""></a>\r
+</br>\r
+<a href=""></a>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+</p><p>\r
+\r
+</p>\r
+</body>\r
+</html>
\ No newline at end of file