READ_ME

   1
   2 What is XBoard?
   3 ===============
   4 XBoard is a graphical chessboard that can serve as a user interface
   5 for GNU Chess, for the Internet Chess Server, or for electronic mail
   6 correspondence chess.  XBoard can also be used by itself.  See the
   7 manual page xboard.man for further details; use the command "nroff
   8 -man xboard.man | more" to read it.
   9
  10 Building XBoard
  11 ===============
  12 Quick start:  You can build xboard on most systems with the commands
  13
  14         configure
  15         make
  16
  17 See the file INSTALL for more detailed instructions.
  18
  19 See the file FAQ for answers to frequently asked questions.
  20
  21 Reporting problems
  22 ==================
  23
  24 Report bugs and problems with XBoard to <tim@tim-mann.org>.  Please
  25 use the "script" program to start a typescript, run XBoard with the
  26 -debug option, and include the typescript output in your message.
  27 Also tell us what kind of machine and what operating system version
  28 you are using.  The command "uname -a" will often tell you this.
  29
  30 Here is a sample of approximately what you should type:
  31
  32     script
  33     uname -a
  34     ./configure
  35     make
  36     ./xboard -debug
  37     exit
  38     mail tim@tim-mann.org
  39     Subject: Your short description of the problem
  40     Your detailed description of the problem
  41     ~r typescript
  42     .
  43
  44 If you improve XBoard, please send a message about your changes, and
  45 we will get in touch with you about merging them in to the main line
  46 of development.
  47
  48 Caveats
  49 =======
  50 XBoard depends on the Xt Intrinsics and Athena Widget Set of X11R4 or
  51 later.  In particular, X11R3 just won't do.
  52
  53 XBoard works best with version 4.0 or 5.0 of GNU Chess.  Older
  54 versions may also work, but they are unsupported.  The GNU Chess
  55 project requests that you get a current copy of GNU Chess rather than
  56 using older, bug-ridden versions.  GNU Chess 4.0 must be compiled with
  57 the -DXBOARD flag for use with XBoard.  Use the "make gnuchessx"
  58 target in GNU Chess 4.0 to do this.
  59
  60 The Free Software Foundation would prefer to be able to distribute an
  61 X chessboard program covered only by the GNU General Public License
  62 and unencumbered by any other copyright.  If you can help with this,
  63 please contact the FSF.