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         ./autogen.sh
  16         ./configure
  17         make
  18
  19 See the file INSTALL for more detailed instructions.
  20
  21 See the file FAQ.html for answers to frequently asked questions.
  22
  23
  24 What is WinBoard?
  25 =================
  26 WinBoard is a port of XBoard to run natively on Windows.  It is part
  27 of the XBoard project and is released under the same terms as XBoard.
  28
  29 You can build WinBoard using the free Cygwin toolchain from
  30 www.cygnus.com with the following commands.
  31
  32         cd winboard
  33         make -f makefile.gcc
  34
  35 You can build WinBoard using Microsoft Visual C with the following
  36 commands, or by opening the project in Visual Studio and clicking the
  37 build button.
  38
  39         cd winboard
  40         nmake -f makefile.ms
  41
  42
  43 Reporting problems
  44 ==================
  45
  46 Report bugs and problems with XBoard and WinBoard to
  47 <bug-xboard@gnu.org>.  With XBoard, please use the "script" program
  48 to start a typescript, run XBoard with the -debug command line option,
  49 and include the typescript output in your message.  With WinBoard,
  50 please use the /debug command line option and include the contents of
  51 the file WinBoard.debug.  Also tell us what kind of machine and what
  52 operating system version you are using.  On Unix, the command "uname
  53 -a" will tell you this.  On Windows, right-click on My Computer and
  54 select Properties.
  55
  56 Here is a sample of approximately what you should type (on Unix):
  57
  58     script
  59     uname -a
  60     ./configure
  61     make
  62     ./xboard -debug
  63     exit
  64     mail bug-xboard@gnu.org
  65     Subject: Your short description of the problem
  66     Your detailed description of the problem
  67     ~r typescript
  68     .
  69
  70 If you improve XBoard, please send a message about your changes, and
  71 we will get in touch with you about merging them in to the main line
  72 of development.
  73