Initial checkin. I created this by combining the XBoard 4.2.6 and
[xboard.git] / winboard / READ_ME.txt
1 WinBoard is a graphical chessboard for 32-bit Microsoft\r
2 Windows systems.  It can serve as a user interface for\r
3 GNU Chess or for internet chess servers, or it can be\r
4 used to play out games manually or from game files.\r
5 For full details, see the Help file (WinBoard.hlp).\r
6 For answers for frequently asked questions, see the\r
7 FAQ file (FAQ.html).\r
8 \r
9 WinBoard is free software.  You can redistribute it\r
10 and/or modify it under the GPL, as described in the\r
11 files COPYRIGHT and COPYING.  If your distribution\r
12 does not include the source code, you can get it from\r
13 the author's Web page:\r
14 \r
15  http://www.tim-mann.org/chess.html\r
16 \r
17 GNU CHESS\r
18 \r
19 A version of GNU Chess is included in the WinBoard \r
20 distribution.  GNU Chess is free software released\r
21 under the GPL.  Source code for GNU Chess is available\r
22 from the Free Software Foundation:\r
23 \r
24  http://www.gnu.org/\r
25 \r
26 GNU Chess 5.02 was compiled with the Cygwin toolkit\r
27 and linked against the Cygwin1.dll library.  Cygwin\r
28 is free software released under the GPL; source code\r
29 is available through:\r
30 \r
31  http://www.cygnus.com/\r
32 \r
33 BUGS AND IMPROVEMENTS\r
34 \r
35 Report bugs in WinBoard or XBoard to the author,\r
36 Tim Mann <tim@tim-mann.org>.  Report bugs in \r
37 GNU Chess to <bug-gnu-chess@gnu.org>.  Give full\r
38 details, including the program's version number\r
39 and the exact text of any error messages.  If you\r
40 improve WinBoard or XBoard, please send a message\r
41 about your changes to <tim@tim-mann.org>. \r
42 Remember that these programs are released under \r
43 the GPL, so source code is freely available, but\r
44 if you distribute modified versions, you must\r
45 distribute the source code modifications under \r
46 the GPL as well.\r
47 \r
48 HISTORY\r
49 \r
50 WinBoard is a port of the Unix program XBoard to\r
51 Win32, the 32-bit Microsoft Windows API.\r
52 The graphical front end (WinBoard.c, etc.) is all\r
53 new, but the back end that understands chess rules,\r
54 chess notation, GNU Chess, the ICS, etc., is shared\r
55 with XBoard.  See WinBoard.hlp for a list of\r
56 contributors to WinBoard and XBoard.\r
57 \r
58 MANUAL INSTALLATION\r
59 \r
60 For a minimal installation of WinBoard and its\r
61 companion version of GNU Chess, create a new\r
62 directory and copy the following files to it:\r
63 \r
64 WinBoard.exe  (WinBoard program)\r
65 WinBoard.hlp  (WinBoard documentation)\r
66 gnuchess.exe  (GNU Chess 4 engine used by WinBoard)\r
67 gnuchesr.exe  (Command-line GNU Chess 4 engine)\r
68 gnuchess.lan  (GNU Chess 4 messages file)\r
69 gnuchess.dat  (GNU Chess 4 opening book)\r
70 gnuchess.txt  (GNU Chess 4 documentation)\r
71 gnuches5.exe  (GNU Chess 5 engine)\r
72 book.dat      (GNU Chess 5 opening book)\r
73 gnuches5.txt  (GNU Chess 5 documentation)\r
74 \r
75 Use the Program Manager or the Explorer to create an\r
76 icon for WinBoard.exe, and set its working directory\r
77 to the directory you created.  Besides looking for\r
78 its companion files in this directory, WinBoard also\r
79 loads and saves game, position, and setting files\r
80 there.\r