aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
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)