From 04d051ba37f71c84422843f1aa14457bedef2ddb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABlle=20Martin?= Date: Thu, 4 Sep 2025 22:45:49 +0200 Subject: [PATCH] docs/#0: added small user guide to the README. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 2f3a4f1..97c34f6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # Diamant-AI Repository of the project to create an AI to play the boardgame "Diamant". +See: [Diamant board game - Wikipedia](https://en.wikipedia.org/wiki/Diamant_(board_game)) +Note: Only the base game works for now, the Monte Carlo Tree Search has not been implemented yet :c + +## User Guide + +1) Install Python 3.11+ on your computer. +2) On Linux, open a CLI and run the script: `python3.11 src/main.py` + + +## TODO List + +- [ ] Setup a virtual environment. +- [ ] Code the MCTS AI player. +- [ ] Integrate joblib library to help MCTS computer faster the win/lose probabilities. ## Code Styling