Compile without DEBUG flag by default
[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. If you are using more than four threads, it
18 is recommended to raise the value of "Minimum Split Depth" UCI parameter
19 to 6.
20 \r
21 \r
22 2. Files\r
23 --------\r
24 \r
25 This distribution of Stockfish consists of the following files:\r
26 \r
27   * Readme.txt, the file you are currently reading.\r
28 \r
29   * Copying.txt, a text file containing the GNU General Public\r
30     License.\r
31 \r
32   * src/, a subdirectory containing the full source code, including a\r
33     Makefile that can be used to compile Stockfish on Unix-like\r
34     systems.  For further information about how to compile Stockfish\r
35     yourself, read section 4 below.\r
36 \r
37   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot\r
38     adapter.\r
39 \r
40 \r
41 3. Opening books\r
42 ----------------\r
43 \r
44 This version of Stockfish has experimental support for PolyGlot opening\r
45 books. For information about how to create such books, consult the\r
46 PolyGlot documentation.  The book file can be selected by setting the\r
47 UCI parameter "Book File".\r
48 \r
49 \r
50 4. Compiling it yourself\r
51 ------------------------\r
52 \r
53 On Unix-like systems, it should usually be possible to compile\r
54 Stockfish directly from the source code with the included Makefile.\r
55 The exception is computer with big-endian CPUs, like PowerPC\r
56 Macintoshes. Some of the bitboard routines in the current version of\r
57 Stockfish are endianness-sensitive, and won't work on a big-endian CPU.\r
58 \r
59 Stockfish has POPCNT instruction runtime detection and support. This can\r
60 give an extra speed on Core i7 or similar systems. To enable this feature\r
61 (disabled by default) simply uncomment #define USE_POPCNT in bitcount.h\r
62 before to compile.\r
63 \r
64 On 64 bit Unix-like systems the 'bsfq' assembly instruction will be used\r
65 for bit counting. Detection is automatic at compile time, but in case you\r
66 experience compile problems you can comment out #define USE_BSFQ line in types.h\r
67 \r
68 \r
69 5. Terms of use\r
70 ---------------\r
71 \r
72 Stockfish is free, and distributed under the GNU General Public License\r
73 (GPL).  Essentially, this means that you are free to do almost exactly\r
74 what you want with the program, including distributing it among your\r
75 friends, making it available for download from your web site, selling\r
76 it (either by itself or as part of some bigger software package), or\r
77 using it as the starting point for a software project of your own.\r
78 \r
79 The only real limitation is that whenever you distribute Stockfish in\r
80 some way, you must always include the full source code, or a pointer\r
81 to where the source code can be found.  If you make any changes to the\r
82 source code, these changes must also be made available under the GPL.\r
83 \r
84 For full details, read the copy of the GPL found in the file named\r
85 Copying.txt.\r
86 \r
87 \r
88 6. Feedback\r
89 -----------\r
90 \r
91 The author's e-mail address is mcostalba@gmail.com\r