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.
  76
  77 Version 4.3.14
  78 ==============
  79
  80 This relaese was not made by the GNU xboard team, but by H.G.Muller.
  81 It mainly contains developments on WinBoard. Nevertheless, an attempt
  82 has been started to back-port the enormous number of improvements that
  83 have been made to WinBoard since the Linux and Windows developments branched
  84 to xboard. This is reflected by the source tree now having the same format
  85 as that of xboard 4.2.7, including all the xboard sources.
  86
  87 An enormous amount of work still has to be done to make the xboard version
  88 fully equivalent to WinBoard, especially on user-interface side. As a modest
  89 beginning, the xboard source files have been patched to allow their compilation
  90 with the newer back-end files from WinBoard. To this end, the number of piece
  91 types in xboard has been increased from 6 to 22, and the WinBoard bitmaps
  92 have been converted to xboard source format (.bm) and are included in the
  93 xboard bitmaps directory. Other quick patches include the coloring of the
  94 board squares (for xiangqi and holdings), and some code in the user-move
  95 handling to suppress all moves into or out of the area between board and
  96 holdings in crazyhouse, and the treatment of king-captures-own-piece
  97 as a possibly valid move (for FRC castling). This should make it possible
  98 to run xboard with the new back-end files without too much inconvenience.
  99
 100 New xboard command-line options have been added to make the added back-end
 101 features available. The include the new variants (as argument of the old
 102 -variant option), -boardWidth, -boardHeight and -holdingsSize. Be sure
 103 to call xboard with "-boardSize middling" or "-boardSize bulky" if you
 104 want to play with fairy pieces, or xboard might crash due to unavailability
 105 of bitmaps. Other added xboard options are:
 106
 107 ADJUDICATION OPTIONS:
 108 -checkMates
 109 -testClaims
 110 -materialDraws
 111 -trivialDraws
 112 -ruleMoves
 113 -repeatsToDraw
 114 -adjudicateLossThreshold
 115 -firstScoreAbsolute
 116 -secondScoreAbsolute
 117
 118 TIME-CONTROL OPTIONS
 119 -firstTimeOdds
 120 -secondTimeOdds
 121 -timeOddsMode
 122 -firstNPS
 123 -secondNPS
 124
 125 GENERAL OPTIONS
 126 -matchPause
 127 -engineDebugOutput
 128 -userName
 129 -pgnExtendedInfo
 130 -pgnEventHeader
 131 -hideThinkingFromHuman
 132
 133 This is all completely untested, but as the options merely switch on well-tested
 134 code in the back-end, there should not be too many problems with them.
 135 Bugs can be reported in the WinBoard forum.