1What is XBoard?
2===============
3XBoard is a graphical chessboard for the X Window System.  It can
4serve as a user interface for chess engines such as Fairy-Max,
5Crafty or GNU Chess, for the Internet Chess Server, or for electronic
6mail correspondence chess. It supports all major forms of chess, such
7as international chess, xiangqi and shogi. XBoard can also be used by
8itself as viewer for stored chess games.  See the manual page for
9further details.
10
11XBoard is free software, copyrighted by the Free Software Foundation
12and released under the GNU General Public License (GPL).  See the file
13COPYING for details.
14
15You can build xboard on most systems with the following commands.
16
17	./configure
18	make
19
20See the file INSTALL for more detailed instructions.
21
22See the file FAQ.html for answers to frequently asked questions.
23
24
25What is WinBoard?
26=================
27WinBoard is a port of XBoard to run natively on Windows.  It is part
28of the XBoard project and is released under the same terms as XBoard.
29
30You can build WinBoard using the free Cygwin toolchain from
31www.cygnus.com with the following commands.
32
33	cd winboard
34	make -f makefile.gcc
35
36You can build WinBoard using Microsoft Visual C with the following
37commands, or by opening the project in Visual Studio and clicking the
38build button.
39
40	cd winboard
41	nmake -f makefile.ms
42
43
44Reporting problems
45==================
46
47Report bugs and problems with XBoard and WinBoard to
48<bug-xboard@gnu.org>.  With XBoard, please use the "script" program
49to start a typescript, run XBoard with the -debug command line option,
50and include the typescript output in your message.  With WinBoard,
51please use the /debug command line option and include the contents of
52the file WinBoard.debug.  Also tell us what kind of machine and what
53operating system version you are using.  On Unix, the command "uname
54-a" will tell you this.  On Windows, right-click on My Computer and
55select Properties.
56
57Here is a sample of approximately what you should type (on Unix):
58
59    script
60    uname -a
61    ./configure
62    make
63    ./xboard -debug
64    exit
65    mail bug-xboard@gnu.org
66    Subject: Your short description of the problem
67    Your detailed description of the problem
68    ~r typescript
69    .
70
71If you improve XBoard, please send a message about your changes, and
72we will get in touch with you about merging them in to the main line
73of development.
74