aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdam <adammegarules1@gmail.com>2026-07-26 19:38:46 +0200
committerAdam <adammegarules1@gmail.com>2026-07-26 19:38:46 +0200
commit5d73a09b5dd707f44253f2080f67805c5b631309 (patch)
tree992613c2f2aea786545a9b647b1e4ebc262fb30a /README.md
parent7e8d89f357aaf8d8a6148ef051752dd53eb0285f (diff)
actualy improving readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files 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
+```