Merge Lucas's "SEE pruning at PV nodes"
[stockfish] / Readme.md
1 ### Overview
2
3 Stockfish is a free UCI chess engine derived from Glaurung 2.1. It is
4 not a complete chess program and requires some UCI-compatible GUI
5 (e.g. XBoard with PolyGlot, eboard, Arena, Sigma Chess, Shredder, Chess
6 Partner or Fritz) in order to be used comfortably. Read the
7 documentation for your GUI of choice for information about how to use
8 Stockfish with it.
9
10 This version of Stockfish supports up to 64 CPUs, but has not been
11 tested thoroughly with more than 4.  The program tries to detect the
12 number of CPUs on your computer and sets the number of search threads
13 accordingly, but please be aware that the detection is not always
14 correct. It is therefore recommended to inspect the value of the
15 *Threads* UCI parameter, and to make sure it equals the number of CPU
16 cores on your computer. If you are using more than eight threads, it is
17 recommended to raise the value of the *Min Split Depth* UCI parameter to 7.
18
19
20 ### Files
21
22 This distribution of Stockfish consists of the following files:
23
24   * Readme.md, the file you are currently reading.
25
26   * Copying.txt, a text file containing the GNU General Public License.
27
28   * src/, a subdirectory containing the full source code, including a Makefile
29     that can be used to compile Stockfish on Unix-like systems. For further
30     information about how to compile Stockfish yourself read section below.
31
32   * polyglot.ini, for using Stockfish with Fabien Letouzey's PolyGlot
33     adapter.
34
35
36 ### Opening books
37
38 This version of Stockfish has support for PolyGlot opening books. For
39 information about how to create such books, consult the PolyGlot
40 documentation. The book file can be selected by setting the *Book File*
41 UCI parameter.
42
43
44 ### Compiling it yourself
45
46 On Unix-like systems, it should be possible to compile Stockfish
47 directly from the source code with the included Makefile.
48
49 Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
50 instruction, big-endian machines such as Power PC, and other platforms.
51
52 In general it is recommended to run `make help` to see a list of make
53 targets with corresponding descriptions. When not using Makefile to
54 compile (for instance with Microsoft MSVC) you need to manually
55 set/unset some switches in the compiler command line; see file *types.h*
56 for a quick reference.
57
58
59 ### Terms of use
60
61 Stockfish is free, and distributed under the **GNU General Public License**
62 (GPL). Essentially, this means that you are free to do almost exactly
63 what you want with the program, including distributing it among your
64 friends, making it available for download from your web site, selling
65 it (either by itself or as part of some bigger software package), or
66 using it as the starting point for a software project of your own.
67
68 The only real limitation is that whenever you distribute Stockfish in
69 some way, you must always include the full source code, or a pointer
70 to where the source code can be found. If you make any changes to the
71 source code, these changes must also be made available under the GPL.
72
73 For full details, read the copy of the GPL found in the file named
74 *Copying.txt*