@@ -59,9 +59,38 @@ This distribution of Stockfish consists of the following files:
59
59
* a file with the .nnue extension, storing the neural network for the NNUE
60
60
evaluation. Binary distributions will have this file embedded.
61
61
62
- ## Contributing
62
+ ## The UCI protocol
63
+
64
+ The [ Universal Chess Interface] [ uci-link ] (UCI) is a standard text-based protocol
65
+ used to communicate with a chess engine and is the recommended way to do so for
66
+ typical graphical user interfaces (GUI) or chess tools. Stockfish implements the
67
+ majority of its options.
68
+
69
+ Developers can see the default values for the UCI options available in Stockfish
70
+ by typing ` ./stockfish uci ` in a terminal, but most users should typically use a
71
+ chess GUI to interact with Stockfish.
72
+
73
+ For more information on UCI or debug commands, see our [ documentation] [ wiki-commands-link ] .
74
+
75
+ ## Compiling Stockfish
63
76
64
- __ See [ Contributing Guide] ( CONTRIBUTING.md ) .__
77
+ Stockfish has support for 32 or 64-bit CPUs, certain hardware instructions,
78
+ big-endian machines such as Power PC, and other platforms.
79
+
80
+ On Unix-like systems, it should be easy to compile Stockfish directly from the
81
+ source code with the included Makefile in the folder ` src ` . In general, it is
82
+ recommended to run ` make help ` to see a list of make targets with corresponding
83
+ descriptions.
84
+
85
+ ```
86
+ cd src
87
+ make -j build ARCH=x86-64-modern
88
+ ```
89
+
90
+ Detailed compilation instructions for all platforms can be found in our
91
+ [ documentation] [ wiki-compile-link ] .
92
+
93
+ ## Contributing
65
94
66
95
### Donating hardware
67
96
@@ -85,25 +114,6 @@ Discussions about Stockfish take place these days mainly in the Stockfish
85
114
[ Discord server] [ discord-link ] . This is also the best place to ask questions
86
115
about the codebase and how to improve it.
87
116
88
- ## Compiling Stockfish
89
-
90
- Stockfish has support for 32 or 64-bit CPUs, certain hardware instructions,
91
- big-endian machines such as Power PC, and other platforms.
92
-
93
- On Unix-like systems, it should be easy to compile Stockfish directly from the
94
- source code with the included Makefile in the folder ` src ` . In general, it is
95
- recommended to run ` make help ` to see a list of make targets with corresponding
96
- descriptions. An example suitable for most Intel and AMD chips:
97
-
98
- ```
99
- cd src
100
- make -j profile-build ARCH=x86-64-avx2
101
- ```
102
-
103
- Detailed compilation instructions for all platforms can be found in our
104
- [ documentation] [ wiki-compile-link ] . Our wiki also has information about
105
- the [ UCI commands] [ wiki-uci-link ] supported by Stockfish.
106
-
107
117
## Terms of use
108
118
109
119
Stockfish is free and distributed under the
@@ -128,7 +138,7 @@ also be made available under GPL v3.
128
138
[ issue-link ] : https://github.com/official-stockfish/Stockfish/issues/new?assignees=&labels=&template=BUG-REPORT.yml
129
139
[ discussions-link ] : https://github.com/official-stockfish/Stockfish/discussions/new
130
140
[ fishtest-link ] : https://tests.stockfishchess.org/tests
131
- [ guideline-link ] : https://github.com/official-stockfish /fishtest/wiki/Creating-my-first-test
141
+ [ guideline-link ] : https://github.com/glinscott /fishtest/wiki/Creating-my-first-test
132
142
[ license-link ] : https://github.com/official-stockfish/Stockfish/blob/master/Copying.txt
133
143
[ programming-link ] : https://www.chessprogramming.org/Main_Page
134
144
[ programmingsf-link ] : https://www.chessprogramming.org/Stockfish
@@ -140,10 +150,10 @@ also be made available under GPL v3.
140
150
[ website-link ] : https://stockfishchess.org
141
151
[ website-blog-link ] : https://stockfishchess.org/blog/
142
152
[ wiki-link ] : https://github.com/official-stockfish/Stockfish/wiki
143
- [ wiki-compile-link ] : https://github.com/official-stockfish/Stockfish/wiki/Compiling-from-source
144
- [ wiki-uci-link ] : https://github.com/official-stockfish/Stockfish/wiki/UCI-&-Commands
145
153
[ wiki-usage-link ] : https://github.com/official-stockfish/Stockfish/wiki/Download-and-usage
146
- [ worker-link ] : https://github.com/official-stockfish/fishtest/wiki/Running-the-worker
154
+ [ wiki-compile-link ] : https://github.com/official-stockfish/Stockfish/wiki/Compiling-from-source
155
+ [ wiki-commands-link ] : https://github.com/official-stockfish/Stockfish/wiki/Commands
156
+ [ worker-link ] : https://github.com/glinscott/fishtest/wiki/Running-the-worker
147
157
148
158
[ 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
149
159
[ commits-badge ] : https://img.shields.io/github/commits-since/official-stockfish/Stockfish/latest?style=for-the-badge
0 commit comments