Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.13 KB

README.md

File metadata and controls

65 lines (47 loc) · 2.13 KB
Raw

ChessEngine

C++ build cpp-linter

C++ chess engine

Beginning of a project to build my own chess engine along with GUI for playing against the engine.

First tasks:

  • Design base classes for the board representation
  • Enable pieces to move
  • Generate all legal moves (if in check etc.)
  • Update PGN with notations
  • Basic GUI with pieces and ability to move them
  • Create tests for implemented classes and methods

Building

Using the included CMakeLists.txt file.

git clone https://github.com/ryan597/chessengine.git
cd chessengine
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCPM_SOURCE_CACHE=cmake
cmake --build build -j8

Testing

This project will use the Catch2 testing framework for C++ unit tests. CMake will automatically download and build Catch2 for you if you build with the -DBUILD_TESTING=on flag.

You can install Catch2 (v3) on your own system with the following

git clone https://github.com/catchorg/Catch2.git
cd Catch2
cmake -B build -H. -DBUILD_TESTING=OFF -j8
sudo cmake --build build/ --target install

Tests can be run after building

cd chessengine
cmake -S . -B build -DBUILD_TESTING=ON -DCPM_SOURCE_CACHE=cmake
cmake --build build -j4
cd build && make test

To generate the CodeCoverage report you need to have installed lcov, then you can make the target.

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DCPM_SOURCE_CACHE=cmake
cmake --build build -j8
cd build && make coverage

The coverage report is viewable by opening the file ./build/coverage/index.html in a web browser