X-Git-Url: https://git.sesse.net/?p=stockfish;a=blobdiff_plain;f=README.md;fp=README.md;h=52b123cbd25e2bf617b85fe0ce6fa301e7b91299;hp=1f462d315af2f076dc51762201ee206c97ec9b09;hb=bfee35f930bac95b646b1821339f342c70aac2f6;hpb=487c21b1aa64dcc09dd95b845a66f39ae3c3754e diff --git a/README.md b/README.md index 1f462d31..52b123cb 100644 --- a/README.md +++ b/README.md @@ -59,39 +59,10 @@ This distribution of Stockfish consists of the following files: * a file with the .nnue extension, storing the neural network for the NNUE evaluation. Binary distributions will have this file embedded. -## The UCI protocol - -The [Universal Chess Interface][uci-link] (UCI) is a standard text-based protocol -used to communicate with a chess engine and is the recommended way to do so for -typical graphical user interfaces (GUI) or chess tools. Stockfish implements the -majority of its options. - -Developers can see the default values for the UCI options available in Stockfish -by typing `./stockfish uci` in a terminal, but most users should typically use a -chess GUI to interact with Stockfish. - -For more information on UCI or debug commands, see our [documentation][wiki-commands-link]. - -## Compiling Stockfish - -Stockfish has support for 32 or 64-bit CPUs, certain hardware instructions, -big-endian machines such as Power PC, and other platforms. - -On Unix-like systems, it should be easy to compile Stockfish directly from the -source code with the included Makefile in the folder `src`. In general, it is -recommended to run `make help` to see a list of make targets with corresponding -descriptions. - -``` -cd src -make -j build ARCH=x86-64-modern -``` - -Detailed compilation instructions for all platforms can be found in our -[documentation][wiki-compile-link]. - ## Contributing +__See [Contributing Guide](CONTRIBUTING.md).__ + ### Donating hardware Improving Stockfish requires a massive amount of testing. You can donate your @@ -114,6 +85,25 @@ Discussions about Stockfish take place these days mainly in the Stockfish [Discord server][discord-link]. This is also the best place to ask questions about the codebase and how to improve it. +## Compiling Stockfish + +Stockfish has support for 32 or 64-bit CPUs, certain hardware instructions, +big-endian machines such as Power PC, and other platforms. + +On Unix-like systems, it should be easy to compile Stockfish directly from the +source code with the included Makefile in the folder `src`. In general, it is +recommended to run `make help` to see a list of make targets with corresponding +descriptions. An example suitable for most Intel and AMD chips: + +``` +cd src +make -j profile-build ARCH=x86-64-avx2 +``` + +Detailed compilation instructions for all platforms can be found in our +[documentation][wiki-compile-link]. Our wiki also has information about +the [UCI commands][wiki-uci-link] supported by Stockfish. + ## Terms of use Stockfish is free and distributed under the @@ -138,7 +128,7 @@ also be made available under GPL v3. [issue-link]: https://github.com/official-stockfish/Stockfish/issues/new?assignees=&labels=&template=BUG-REPORT.yml [discussions-link]: https://github.com/official-stockfish/Stockfish/discussions/new [fishtest-link]: https://tests.stockfishchess.org/tests -[guideline-link]: https://github.com/glinscott/fishtest/wiki/Creating-my-first-test +[guideline-link]: https://github.com/official-stockfish/fishtest/wiki/Creating-my-first-test [license-link]: https://github.com/official-stockfish/Stockfish/blob/master/Copying.txt [programming-link]: https://www.chessprogramming.org/Main_Page [programmingsf-link]: https://www.chessprogramming.org/Stockfish @@ -150,10 +140,10 @@ also be made available under GPL v3. [website-link]: https://stockfishchess.org [website-blog-link]: https://stockfishchess.org/blog/ [wiki-link]: https://github.com/official-stockfish/Stockfish/wiki -[wiki-usage-link]: https://github.com/official-stockfish/Stockfish/wiki/Download-and-usage [wiki-compile-link]: https://github.com/official-stockfish/Stockfish/wiki/Compiling-from-source -[wiki-commands-link]: https://github.com/official-stockfish/Stockfish/wiki/Commands -[worker-link]: https://github.com/glinscott/fishtest/wiki/Running-the-worker +[wiki-uci-link]: https://github.com/official-stockfish/Stockfish/wiki/UCI-&-Commands +[wiki-usage-link]: https://github.com/official-stockfish/Stockfish/wiki/Download-and-usage +[worker-link]: https://github.com/official-stockfish/fishtest/wiki/Running-the-worker [build-badge]: https://img.shields.io/github/actions/workflow/status/official-stockfish/Stockfish/stockfish.yml?branch=master&style=for-the-badge&label=stockfish&logo=github [commits-badge]: https://img.shields.io/github/commits-since/official-stockfish/Stockfish/latest?style=for-the-badge