git.sesse.net Git - stockfish/blob - 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 128 cores. The engine defaults
  11 to one search thread, so it is therefore recommended to inspect the value of
  12 the *Threads* UCI parameter, and to make sure it equals the number of CPU
  13 cores on your computer.
  14
  15
  16 ### Files
  17
  18 This distribution of Stockfish consists of the following files:
  19
  20   * Readme.md, the file you are currently reading.
  21
  22   * Copying.txt, a text file containing the GNU General Public License.
  23
  24   * src, a subdirectory containing the full source code, including a Makefile
  25     that can be used to compile Stockfish on Unix-like systems.
  26
  27
  28 ### Compiling it yourself
  29
  30 On Unix-like systems, it should be possible to compile Stockfish
  31 directly from the source code with the included Makefile.
  32
  33 Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
  34 instruction, big-endian machines such as Power PC, and other platforms.
  35
  36 In general it is recommended to run `make help` to see a list of make
  37 targets with corresponding descriptions. When not using the Makefile to
  38 compile (for instance with Microsoft MSVC) you need to manually
  39 set/unset some switches in the compiler command line; see file *types.h*
  40 for a quick reference.
  41
  42
  43 ### Terms of use
  44
  45 Stockfish is free, and distributed under the **GNU General Public License**
  46 (GPL). Essentially, this means that you are free to do almost exactly
  47 what you want with the program, including distributing it among your
  48 friends, making it available for download from your web site, selling
  49 it (either by itself or as part of some bigger software package), or
  50 using it as the starting point for a software project of your own.
  51
  52 The only real limitation is that whenever you distribute Stockfish in
  53 some way, you must always include the full source code, or a pointer
  54 to where the source code can be found. If you make any changes to the
  55 source code, these changes must also be made available under the GPL.
  56
  57 For full details, read the copy of the GPL found in the file named
  58 *Copying.txt*