use autoheader to create config.h.in
[xboard.git] / READ_ME
diff --git a/READ_ME b/READ_ME
index 17d4cbd..a27021b 100644 (file)
--- a/READ_ME
+++ b/READ_ME
-
-What is XBoard?
-===============
-XBoard is a graphical chessboard that can serve as a user interface
-for GNU Chess, for the Internet Chess Server, or for electronic mail
-correspondence chess.  XBoard can also be used by itself.  See the
-manual page xboard.man for further details; use the command "nroff
--man xboard.man | more" to read it.
-
-Building XBoard
-===============
-Quick start:  You can build xboard on most systems with the commands
-
-       configure
-       make
-
-See the file INSTALL for more detailed instructions.
-
-See the file FAQ for answers to frequently asked questions.
-
-Reporting problems
-==================
-
-Report bugs and problems with XBoard to <tim@tim-mann.org>.  Please
-use the "script" program to start a typescript, run XBoard with the
--debug option, and include the typescript output in your message.
-Also tell us what kind of machine and what operating system version
-you are using.  The command "uname -a" will often tell you this.
-
-Here is a sample of approximately what you should type:
-
-    script
-    uname -a
-    ./configure
-    make
-    ./xboard -debug
-    exit
-    mail tim@tim-mann.org
-    Subject: Your short description of the problem
-    Your detailed description of the problem
-    ~r typescript
-    .
-
-If you improve XBoard, please send a message about your changes, and
-we will get in touch with you about merging them in to the main line
-of development.
-
-Caveats
-=======
-XBoard depends on the Xt Intrinsics and Athena Widget Set of X11R4 or
-later.  In particular, X11R3 just won't do.
-
-XBoard works best with version 4.0 or 5.0 of GNU Chess.  Older
-versions may also work, but they are unsupported.  The GNU Chess
-project requests that you get a current copy of GNU Chess rather than
-using older, bug-ridden versions.  GNU Chess 4.0 must be compiled with
-the -DXBOARD flag for use with XBoard.  Use the "make gnuchessx"
-target in GNU Chess 4.0 to do this.
-
-The Free Software Foundation would prefer to be able to distribute an
-X chessboard program covered only by the GNU General Public License
-and unencumbered by any other copyright.  If you can help with this,
-please contact the FSF.
+\r
+What is XBoard?\r
+===============\r
+XBoard is a graphical chessboard for the X Window System.  It can\r
+serve as a user interface for chess engines such as GNU Chess, for the\r
+Internet Chess Server, or for electronic mail correspondence chess.\r
+XBoard can also be used by itself.  See the manual page xboard.txt for\r
+further details.\r
+\r
+XBoard is free software, copyrighted by the Free Software Foundation\r
+and released under the GNU General Public License (GPL).  See the file\r
+COPYING for details.\r
+\r
+You can build xboard on most systems with the following commands.\r
+\r
+       ./configure\r
+       make\r
+\r
+See the file INSTALL for more detailed instructions.\r
+\r
+See the file FAQ.html for answers to frequently asked questions.\r
+\r
+\r
+What is WinBoard?\r
+=================\r
+WinBoard is a port of XBoard to run natively on Windows.  It is part\r
+of the XBoard project and is released under the same terms as XBoard.\r
+\r
+You can build WinBoard using the free Cygwin toolchain from\r
+www.cygnus.com with the following commands.\r
+\r
+       cd winboard\r
+       make -f cygwin.mak\r
+\r
+You can build WinBoard using Microsoft Visual C with the following\r
+commands, or by opening the project in Visual Studio and clicking the\r
+build button.\r
+\r
+       cd winboard\r
+       nmake -f msvc.mak\r
+\r
+There is also a contributed .mak file for Borland C.  It's not\r
+maintained and thus may need updating if you want to use it.\r
+\r
+\r
+Reporting problems\r
+==================\r
+\r
+Report bugs and problems with XBoard and WinBoard to\r
+<bug-xboard@gnu.org>.  With XBoard, please use the "script" program\r
+to start a typescript, run XBoard with the -debug command line option,\r
+and include the typescript output in your message.  With WinBoard,\r
+please use the /debug command line option and include the contents of\r
+the file WinBoard.debug.  Also tell us what kind of machine and what\r
+operating system version you are using.  On Unix, the command "uname\r
+-a" will tell you this.  On Windows, right-click on My Computer and\r
+select Properties.\r
+\r
+Here is a sample of approximately what you should type (on Unix):\r
+\r
+    script\r
+    uname -a\r
+    ./configure\r
+    make\r
+    ./xboard -debug\r
+    exit\r
+    mail bug-xboard@gnu.org\r
+    Subject: Your short description of the problem\r
+    Your detailed description of the problem\r
+    ~r typescript\r
+    .\r
+\r
+If you improve XBoard, please send a message about your changes, and\r
+we will get in touch with you about merging them in to the main line\r
+of development.\r
+\r
+Version 4.3.14\r
+==============\r
+\r
+This relaese was not made by the GNU xboard team, but by H.G.Muller.\r
+It mainly contains developments on WinBoard. Nevertheless, an attempt\r
+has been started to back-port the enormous number of improvements that\r
+have been made to WinBoard since the Linux and Windows developments branched\r
+to xboard. This is reflected by the source tree now having the same format\r
+as that of xboard 4.2.7, including all the xboard sources. \r
+\r
+An enormous amount of work still has to be done to make the xboard version\r
+fully equivalent to WinBoard, especially on user-interface side. As a modest\r
+beginning, the xboard source files have been patched to allow their compilation\r
+with the newer back-end files from WinBoard. To this end, the number of piece\r
+types in xboard has been increased from 6 to 22, and the WinBoard bitmaps\r
+have been converted to xboard source format (.bm) and are included in the\r
+xboard bitmaps directory. Other quick patches include the coloring of the\r
+board squares (for xiangqi and holdings), and some code in the user-move\r
+handling to suppress all moves into or out of the area between board and\r
+holdings in crazyhouse, and the treatment of king-captures-own-piece\r
+as a possibly valid move (for FRC castling). This should make it possible \r
+to run xboard with the new back-end files without too much inconvenience.\r
+\r
+New xboard command-line options have been added to make the added back-end \r
+features available. The include the new variants (as argument of the old\r
+-variant option), -boardWidth, -boardHeight and -holdingsSize. Be sure\r
+to call xboard with "-boardSize middling" or "-boardSize bulky" if you\r
+want to play with fairy pieces, or xboard might crash due to unavailability\r
+of bitmaps. Other added xboard options are:\r
+\r
+ADJUDICATION OPTIONS:\r
+-checkMates\r
+-testClaims\r
+-materialDraws\r
+-trivialDraws\r
+-ruleMoves\r
+-repeatsToDraw\r
+-adjudicateLossThreshold\r
+-firstScoreAbsolute\r
+-secondScoreAbsolute\r
+\r
+TIME-CONTROL OPTIONS\r
+-firstTimeOdds\r
+-secondTimeOdds\r
+-timeOddsMode\r
+-firstNPS\r
+-secondNPS\r
+\r
+GENERAL OPTIONS\r
+-matchPause\r
+-engineDebugOutput\r
+-userName\r
+-pgnExtendedInfo\r
+-pgnEventHeader\r
+-hideThinkingFromHuman\r
+\r
+This is all completely untested, but as the options merely switch on well-tested\r
+code in the back-end, there should not be too many problems with them.\r
+Bugs can be reported in the WinBoard forum.
\ No newline at end of file