From 909479dacf8b6390472efe221affd4290dd1a9cb Mon Sep 17 00:00:00 2001 From: Adam Date: Sun, 2 Aug 2026 16:16:44 +0200 Subject: improving readme --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 44a1c2d..7dc1f55 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -Mono +# Mono + A UCI chess engine written in c++ -# Running +## Running -## Requirement +### 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 +### Building ```bash cmake -B build -S . # Run only on cmake config changes (and first time) @@ -23,7 +24,7 @@ cmake --build ./build # Build ./build/chess # Run the app ``` -## Details +### Details - [AddressSanitizer](https://github.com/google/sanitizers/wiki/AddressSanitizer) (aka ASan) - [UndefinedBehaviorSanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html) (aka UBSan) -- cgit v1.2.3