Avoid spamming the GUI in multipv search
[stockfish] / Readme.txt
index 250f5e552bb06f206316cb4f15829fdb541bf2a1..ab4eec082b9125f3eaeeba3dd615cbf8cd34cb0d 100644 (file)
@@ -1,20 +1,22 @@
 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.
+Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is
+not a complete chess program and requires some UCI-compatible GUI
+(e.g. 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 it.
+
+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 sets 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 the "Min Split Depth" UCI parameter to
+7.
 
 
 2. Files
@@ -24,13 +26,12 @@ 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.
+  * 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.
+    For further information about how to compile Stockfish yourself read
+    section 4 below.
 
   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot
     adapter.
@@ -39,32 +40,26 @@ This distribution of Stockfish consists of the following files:
 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".
+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 "Book File"
+UCI parameter.
 
 
 4. Compiling it yourself
 ------------------------
 
-On Unix-like systems, it should usually be possible to compile Stockfish
+On Unix-like systems, it should 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.
+Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
+instruction, big-endian machines such as Power PC, 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 manualy set/unset in the compiler
-command line the following flags:
-
--DNDEBUG       --- Disable debug mode
--DBIGENDIAN    --- big-endian byte order
--DUSE_POPCNT   --- Use popcnt SSE 4.2 asm-instruction
--DIS_64BIT     --- 64bit operating system (auto detected)
--DUSE_PREFETCH --- Use prefetch x86 asm-instruction (auto detected)
--DUSE_BSFQ     --- Use bsfq x86_64 asm-instruction (auto detected)
+In general it 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 some switches in the compiler command line; see file "types.h"
+for a quick reference.
 
 
 5. Terms of use