Only on Windows do wait for input at the end of benchmark
[stockfish] / Readme.txt
1 1. Introduction\r
2 ---------------\r
3 \r
4 Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is\r
5 not a complete chess program, but requires some UCI compatible GUI\r
6 (like XBoard with PolyGlot, eboard, Jos´┐Ż, Arena, Sigma Chess, Shredder,\r
7 Chess Partner, or Fritz) in order to be used comfortably.  Read the\r
8 documentation for your GUI of choice for information about how to use\r
9 Stockfish with your GUI.\r
10 \r
11 This version of Stockfish supports up to 8 CPUs, but has not been\r
12 tested thoroughly with more than 2.  The program tries to detect the\r
13 number of CPUs on your computer and set the number of search threads\r
14 accordingly, but please be aware that the detection is not always\r
15 correct.  It is therefore recommended to inspect the value of the\r
16 "Threads" UCI parameter, and to make sure it equals the number of CPU\r
17 cores on your computer.\r
18 \r
19 \r
20 2. Files\r
21 --------\r
22 \r
23 This distribution of Stockfish consists of the following files:\r
24 \r
25   * Readme.txt, the file you are currently reading.\r
26 \r
27   * Copying.txt, a text file containing the GNU General Public\r
28     License.\r
29 \r
30   * src/, a subdirectory containing the full source code, including a\r
31     Makefile that can be used to compile Stockfish on Unix-like\r
32     systems.  For further information about how to compile Stockfish\r
33     yourself, read section 4 below.\r
34 \r
35   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot\r
36     adapter.\r
37 \r
38 \r
39 3. Opening books\r
40 ----------------\r
41 \r
42 This version of Stockfish has experimental support for PolyGlot opening\r
43 books. For information about how to create such books, consult the\r
44 PolyGlot documentation.  The book file can be selected by setting the\r
45 UCI parameter "Book File".\r
46 \r
47 \r
48 \r
49 4. Compiling it yourself\r
50 ------------------------\r
51 \r
52 On Unix-like systems, it should usually be possible to compile\r
53 Stockfish directly from the source code with the included Makefile.\r
54 The exception is computer with big-endian CPUs, like PowerPC\r
55 Macintoshes. Some of the bitboard routines in the current version of\r
56 Stockfish are endianness-sensitive, and won't work on a big-endian CPU.\r
57 Ensuring that the line with #define USE_32BIT_ATTACKS" near the top\r
58 of bitboard.h is commented out should solve this problem.\r
59 Commenting out the line with "#define USE_32BIT_ATTACKS" near the\r
60 \r
61 There is also a problem with compiling Stockfish on certain 64-bit\r
62 systems, regardless of the endianness.  If Stockfish segfaults\r
63 immediately after startup, try to comment out the line with\r
64 "#define USE_FOLDED_BITSCAN" near the beginning of bitboard.h and\r
65 recompile.\r
66 \r
67 Finally, even if Stockfish does work without any changes on your\r
68 computer, it might be possible to improve the performance by changing\r
69 some of the #define directives in bitboard.h.  The default settings\r
70 are optimized for 64-bit CPUs.  On 32-bit CPUs, it is probably better\r
71 to switch on USE_32BIT_ATTACKS, and to use BITCOUNT_SWAR_32 instead of\r
72 BITCOUNT_SWAR_64.  For computers with very little memory (like\r
73 handheld devices), it is possible to conserve memory by defining\r
74 USE_COMPACT_ROOK_ATTACKS.\r
75 \r
76 \r
77 6. Terms of use\r
78 ---------------\r
79 \r
80 Stockfish is free, and distributed under the GNU General Public License\r
81 (GPL).  Essentially, this means that you are free to do almost exactly\r
82 what you want with the program, including distributing it among your\r
83 friends, making it available for download from your web site, selling\r
84 it (either by itself or as part of some bigger software package), or\r
85 using it as the starting point for a software project of your own.\r
86 \r
87 The only real limitation is that whenever you distribute Stockfish in\r
88 some way, you must always include the full source code, or a pointer\r
89 to where the source code can be found.  If you make any changes to the\r
90 source code, these changes must also be made available under the GPL.\r
91 \r
92 For full details, read the copy of the GPL found in the file named\r
93 Copying.txt.\r
94 \r
95 \r
96 7. Feedback\r
97 -----------\r
98 \r
99 The author's e-mail address is mcostalba@gmail.com\r