X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=READ_ME;h=4ddc9975bc47a6ca3c774dcae2730f095d399deb;hb=84f5fb6b9383e608570b90f6acc12f96d2781979;hp=17d4cbd4402b735fb0f7daaad6283801285c55bf;hpb=05bc30b15e31c427ce208495a889e9ff36e6642b;p=xboard.git diff --git a/READ_ME b/READ_ME index 17d4cbd..4ddc997 100644 --- a/READ_ME +++ b/READ_ME @@ -1,33 +1,62 @@ 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. +XBoard is a graphical chessboard for the X Window System. It can +serve as a user interface for chess engines such as 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.txt for +further details. -Building XBoard -=============== -Quick start: You can build xboard on most systems with the commands +XBoard is free software, copyrighted by the Free Software Foundation +and released under the GNU General Public License (GPL). See the file +COPYING for details. + +You can build xboard on most systems with the following commands. - configure + ./configure make See the file INSTALL for more detailed instructions. -See the file FAQ for answers to frequently asked questions. +See the file FAQ.html for answers to frequently asked questions. + + +What is WinBoard? +================= +WinBoard is a port of XBoard to run natively on Windows. It is part +of the XBoard project and is released under the same terms as XBoard. + +You can build WinBoard using the free Cygwin toolchain from +www.cygnus.com with the following commands. + + cd winboard + make -f cygwin.mak + +You can build WinBoard using Microsoft Visual C with the following +commands, or by opening the project in Visual Studio and clicking the +build button. + + cd winboard + nmake -f msvc.mak + +There is also a contributed .mak file for Borland C. It's not +maintained and thus may need updating if you want to use it. + Reporting problems ================== -Report bugs and problems with XBoard to . 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. +Report bugs and problems with XBoard and WinBoard to +. With XBoard, please use the "script" program +to start a typescript, run XBoard with the -debug command line option, +and include the typescript output in your message. With WinBoard, +please use the /debug command line option and include the contents of +the file WinBoard.debug. Also tell us what kind of machine and what +operating system version you are using. On Unix, the command "uname +-a" will tell you this. On Windows, right-click on My Computer and +select Properties. -Here is a sample of approximately what you should type: +Here is a sample of approximately what you should type (on Unix): script uname -a @@ -35,7 +64,7 @@ Here is a sample of approximately what you should type: make ./xboard -debug exit - mail tim@tim-mann.org + mail bug-xboard@gnu.org Subject: Your short description of the problem Your detailed description of the problem ~r typescript @@ -44,20 +73,3 @@ Here is a sample of approximately what you should type: 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.