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.man for
   8 further details; use the command "nroff -man xboard.man | more" to
   9 read it.
  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 cygwin.mak
  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 msvc.mak
  42
  43 There is also a contributed .mak file for Borland C.  It's not
  44 maintained and thus may need updating if you want to use it.
  45
  46
  47 Reporting problems
  48 ==================
  49
  50 Report bugs and problems with XBoard and WinBoard to
  51 <xboard@tim-mann.org>.  With XBoard, please use the "script" program
  52 to start a typescript, run XBoard with the -debug command line option,
  53 and include the typescript output in your message.  With WinBoard,
  54 please use the /debug command line option and include the contents of
  55 the file WinBoard.debug.  Also tell us what kind of machine and what
  56 operating system version you are using.  On Unix, the command "uname
  57 -a" will tell you this.  On Windows, right-click on My Computer and
  58 select Properties.
  59
  60 Here is a sample of approximately what you should type (on Unix):
  61
  62     script
  63     uname -a
  64     ./configure
  65     make
  66     ./xboard -debug
  67     exit
  68     mail xboard@tim-mann.org
  69     Subject: Your short description of the problem
  70     Your detailed description of the problem
  71     ~r typescript
  72     .
  73
  74 If you improve XBoard, please send a message about your changes, and
  75 we will get in touch with you about merging them in to the main line
  76 of development.