diff --git a/README.md b/README.md index d936efd..c84eb50 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ -# chess + +# Chess -A chess engine +A chess engine with focus on fast move generation. + +## Building + +The following dependencies are used for the GUI: +- gtk 4 +- librsvg (for loading the piece images) + +The engine can be built with cmake. + +``` +cmake . +make +``` + +If you do not use make, replace it with ninja for example. The build script contains multiple +targets: + +- chess: This is the main target. It has a GUI and the user plays as white. The engine responds with + a move for black. +- chessNoComputer: The user can play both sides in a GUI. Mainly added for testing the move + generator. +- findMagicNumber: finds Magic Numbers for the magic bitboard. # sources