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