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