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