From 5d73a09b5dd707f44253f2080f67805c5b631309 Mon Sep 17 00:00:00 2001 From: Adam Date: Sun, 26 Jul 2026 19:38:46 +0200 Subject: actualy improving readme --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9ba378e..a06aa4f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ -Running loccaly: -i dont know just have it work +![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) -![alt text goes here](https://github.com/adammegarules/chess/actions/workflows/cmake-single-platform.yml/badge.svg) -![alt text goes here](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 one time + +cmake --build ./build # Build + +./build/chess # Run the app +``` -- cgit v1.2.3