README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

![Cmake build workflow badge](https://github.com/adammegarules/chess/actions/workflows/cmake-single-platform.yml/badge.svg)
![formating workflow badge](https://github.com/adammegarules/chess/actions/workflows/formating.yml/badge.svg)

# Running

## Requirement

- Cmake (3.24+)
- C/C++ compiler that supports c 23 and c++ 23 standard (GCC 14+, Clang 18+)
- ASan (sudo dnf install libasan)
- UBSan (sudo dnf install libubsan)

## Building

```bash
cmake -B build -S . # Run only on cmake config changes (and first time)
# Or for development
cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug

cmake --build ./build # Build

./build/chess # Run the app
```

## Details

- [AddressSanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer) (aka ASan)
- [UndefinedBehaviorSanitizer¶](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html) (aka UBSan)