READ_ME

   1
   2 What is XBoard?
   3 ===============
   4 XBoard is a graphical chessboard for the X Window System.  It can
   5 serve as a user interface for chess engines such as GNU Chess, for the
   6 Internet Chess Server, or for electronic mail correspondence chess.
   7 XBoard can also be used by itself.  See the manual page xboard.txt for
   8 further details.
   9
  10 XBoard is free software, copyrighted by the Free Software Foundation
  11 and released under the GNU General Public License (GPL).  See the file
  12 COPYING for details.
  13
  14 You can build xboard on most systems with the following commands.
  15
  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 cygwin.mak
  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 msvc.mak
  41
  42 There is also a contributed .mak file for Borland C.  It's not
  43 maintained and thus may need updating if you want to use it.
  44
  45
  46 Reporting problems
  47 ==================
  48
  49 Report bugs and problems with XBoard and WinBoard to
  50 <bug-xboard@gnu.org>.  With XBoard, please use the "script" program
  51 to start a typescript, run XBoard with the -debug command line option,
  52 and include the typescript output in your message.  With WinBoard,
  53 please use the /debug command line option and include the contents of
  54 the file WinBoard.debug.  Also tell us what kind of machine and what
  55 operating system version you are using.  On Unix, the command "uname
  56 -a" will tell you this.  On Windows, right-click on My Computer and
  57 select Properties.
  58
  59 Here is a sample of approximately what you should type (on Unix):
  60
  61     script
  62     uname -a
  63     ./configure
  64     make
  65     ./xboard -debug
  66     exit
  67     mail bug-xboard@gnu.org
  68     Subject: Your short description of the problem
  69     Your detailed description of the problem
  70     ~r typescript
  71     .
  72
  73 If you improve XBoard, please send a message about your changes, and
  74 we will get in touch with you about merging them in to the main line
  75 of development.