Enable POPCNT only through Makefile
[stockfish] / Readme.txt
1 1. Introduction
2 ---------------
3
4 Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is
5 not a complete chess program, but requires some UCI compatible GUI
6 (like XBoard with PolyGlot, eboard, Jos´┐Ż, Arena, Sigma Chess, Shredder,
7 Chess Partner, or Fritz) in order to be used comfortably.  Read the
8 documentation for your GUI of choice for information about how to use
9 Stockfish with your GUI.
10
11 This version of Stockfish supports up to 8 CPUs, but has not been
12 tested thoroughly with more than 2.  The program tries to detect the
13 number of CPUs on your computer and set the number of search threads
14 accordingly, but please be aware that the detection is not always
15 correct.  It is therefore recommended to inspect the value of the
16 "Threads" UCI parameter, and to make sure it equals the number of CPU
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
21
22 2. Files
23 --------
24
25 This distribution of Stockfish consists of the following files:
26
27   * Readme.txt, the file you are currently reading.
28
29   * Copying.txt, a text file containing the GNU General Public
30     License.
31
32   * src/, a subdirectory containing the full source code, including a
33     Makefile that can be used to compile Stockfish on Unix-like
34     systems.  For further information about how to compile Stockfish
35     yourself, read section 4 below.
36
37   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot
38     adapter.
39
40
41 3. Opening books
42 ----------------
43
44 This version of Stockfish has experimental support for PolyGlot opening
45 books. For information about how to create such books, consult the
46 PolyGlot documentation.  The book file can be selected by setting the
47 UCI parameter "Book File".
48
49
50 4. Compiling it yourself
51 ------------------------
52
53 On Unix-like systems, it should usually be possible to compile
54 Stockfish directly from the source code with the included Makefile.
55
56 For big-endian machines like Power PC you need to enable the proper
57 flag changing from -DNBIGENDIAN to -DBIGENDIAN in the Makefile.
58
59 Stockfish has POPCNT instruction runtime detection and support. This can
60 give an extra speed on Core i7 or similar systems. To enable this feature
61 compile with 'make icc-profile-popcnt'
62
63 On 64 bit Unix-like systems the 'bsfq' assembly instruction will be used
64 for bit counting. Detection is automatic at compile time, but in case you
65 experience compile problems you can comment out #define USE_BSFQ line in types.h
66
67
68 5. Terms of use
69 ---------------
70
71 Stockfish is free, and distributed under the GNU General Public License
72 (GPL).  Essentially, this means that you are free to do almost exactly
73 what you want with the program, including distributing it among your
74 friends, making it available for download from your web site, selling
75 it (either by itself or as part of some bigger software package), or
76 using it as the starting point for a software project of your own.
77
78 The only real limitation is that whenever you distribute Stockfish in
79 some way, you must always include the full source code, or a pointer
80 to where the source code can be found.  If you make any changes to the
81 source code, these changes must also be made available under the GPL.
82
83 For full details, read the copy of the GPL found in the file named
84 Copying.txt.
85
86
87 6. Feedback
88 -----------
89
90 The author's e-mail address is mcostalba@gmail.com