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