Merge remote-tracking branch 'upstream/master'
[stockfish] / Readme.txt
index 377d44aa8e15d1cc32d8b25a856b5946aaba7827..6572adee0476b524dfc7c449412c8c87d8fc0b09 100644 (file)
@@ -1,99 +1,79 @@
-1. Introduction\r
----------------\r
-\r
-Stockfish is a free UCI chess engine derived from Glaurung. It is not\r
-a complete chess program, but requires some UCI compatible GUI (like\r
-XBoard with PolyGlot, eboard, Jos´┐Ż, Arena, Sigma Chess, Shredder,\r
-Chess Partner, or Fritz) in order to be used comfortably.  Read the\r
-documentation for your GUI of choice for information about how to use\r
-Stockfish with your GUI.\r
-\r
-This version of Stockfish supports up to 8 CPUs, but has not been\r
-tested thoroughly with more than 2.  The program tries to detect the\r
-number of CPUs on your computer and set the number of search threads\r
-accordingly, but please be aware that the detection is not always\r
-correct.  It is therefore recommended to inspect the value of the\r
-"Threads" UCI parameter, and to make sure it equals the number of CPU\r
-cores on your computer.\r
-\r
-\r
-2. Files\r
---------\r
-\r
-This distribution of Glaurung consists of the following files:\r
-\r
-  * Readme.txt, the file you are currently reading.\r
-\r
-  * Copying.txt, a text file containing the GNU General Public\r
-    License.\r
-\r
-  * src/, a subdirectory containing the full source code, including a\r
-    Makefile that can be used to compile Glaurung on Unix-like\r
-    systems.  For further information about how to compile Glaurung\r
-    yourself, read section 4 below.\r
-\r
-  * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot\r
-    adapter.\r
-\r
-\r
-3. Opening books\r
-----------------\r
-\r
-This version of Stockfish has experimental support for PolyGlot opening\r
-books. For information about how to create such books, consult the\r
-PolyGlot documentation.  The book file can be selected by setting the\r
-UCI parameter "Book File".\r
-\r
-\r
-\r
-4. Compiling it yourself\r
-------------------------\r
-\r
-On Unix-like systems, it should usually be possible to compile\r
-Stockfish directly from the source code with the included Makefile.\r
-The exception is computer with big-endian CPUs, like PowerPC\r
-Macintoshes. Some of the bitboard routines in the current version of\r
-Stockfish are endianness-sensitive, and won't work on a big-endian CPU.\r
-Ensuring that the line with #define USE_32BIT_ATTACKS" near the top\r
-of bitboard.h is commented out should solve this problem.\r
-Commenting out the line with "#define USE_32BIT_ATTACKS" near the\r
-\r
-There is also a problem with compiling Stockfish on certain 64-bit\r
-systems, regardless of the endianness.  If Stockfish segfaults\r
-immediately after startup, try to comment out the line with\r
-"#define USE_FOLDED_BITSCAN" near the beginning of bitboard.h and\r
-recompile.\r
-\r
-Finally, even if Stockfish does work without any changes on your\r
-computer, it might be possible to improve the performance by changing\r
-some of the #define directives in bitboard.h.  The default settings\r
-are optimized for 64-bit CPUs.  On 32-bit CPUs, it is probably better\r
-to switch on USE_32BIT_ATTACKS, and to use BITCOUNT_SWAR_32 instead of\r
-BITCOUNT_SWAR_64.  For computers with very little memory (like\r
-handheld devices), it is possible to conserve memory by defining\r
-USE_COMPACT_ROOK_ATTACKS.\r
-\r
-\r
-6. Terms of use\r
----------------\r
-\r
-Stockfish is free, and distributed under the GNU General Public License\r
-(GPL).  Essentially, this means that you are free to do almost exactly\r
-what you want with the program, including distributing it among your\r
-friends, making it available for download from your web site, selling\r
-it (either by itself or as part of some bigger software package), or\r
-using it as the starting point for a software project of your own.\r
-\r
-The only real limitation is that whenever you distribute Stockfish in\r
-some way, you must always include the full source code, or a pointer\r
-to where the source code can be found.  If you make any changes to the\r
-source code, these changes must also be made available under the GPL.\r
-\r
-For full details, read the copy of the GPL found in the file named\r
-Copying.txt.\r
-\r
-\r
-7. Feedback\r
------------\r
-\r
-The author's e-mail address is mcostalba@gmail.com\r
+1. Introduction
+---------------
+
+Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is not a
+complete chess program, but requires some UCI compatible GUI (like XBoard
+with PolyGlot, eboard, Arena, Sigma Chess, Shredder, Chess Partner or Fritz)
+in order to be used comfortably. Read the documentation for your GUI of choice
+for information about how to use Stockfish with your GUI.
+
+This version of Stockfish supports up to 32 CPUs, but has not been tested
+thoroughly with more than 4.  The program tries to detect the number of
+CPUs on your computer and set the number of search threads accordingly, but
+please be aware that the detection is not always correct. It is therefore
+recommended to inspect the value of the "Threads" UCI parameter, and to
+make sure it equals the number of CPU cores on your computer. If you are
+using more than eight threads, it is recommended to raise the value of
+"Min Split Depth" UCI parameter to 7.
+
+
+2. Files
+--------
+
+This distribution of Stockfish consists of the following files:
+
+  * Readme.txt, the file you are currently reading.
+
+  * Copying.txt, a text file containing the GNU General Public
+    License.
+
+  * src/, a subdirectory containing the full source code, including a
+    Makefile that can be used to compile Stockfish on Unix-like systems.
+    For further information about how to compile Stockfish yourself
+    read section 4 below.
+
+  * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot
+    adapter.
+
+
+3. Opening books
+----------------
+
+This version of Stockfish has support for PolyGlot opening books.
+For information about how to create such books, consult the PolyGlot
+documentation.  The book file can be selected by setting the UCI
+parameter "Book File".
+
+
+4. Compiling it yourself
+------------------------
+
+On Unix-like systems, it should usually be possible to compile Stockfish
+directly from the source code with the included Makefile.
+
+Stockfish has support for 32 or 64 bits CPUS, big-endian machines, like
+Power PC, hardware POPCNT instruction and other platforms.
+
+In general is recommended to run 'make help' to see a list of make targets
+with corresponding descriptions. When not using Makefile to compile, for
+instance with Microsoft MSVC, you need to manually set/unset in the compiler
+command line some swicthes, see file types.h for a quick reference.
+
+
+5. Terms of use
+---------------
+
+Stockfish is free, and distributed under the GNU General Public License
+(GPL). Essentially, this means that you are free to do almost exactly
+what you want with the program, including distributing it among your
+friends, making it available for download from your web site, selling
+it (either by itself or as part of some bigger software package), or
+using it as the starting point for a software project of your own.
+
+The only real limitation is that whenever you distribute Stockfish in
+some way, you must always include the full source code, or a pointer
+to where the source code can be found. If you make any changes to the
+source code, these changes must also be made available under the GPL.
+
+For full details, read the copy of the GPL found in the file named
+Copying.txt.