read me

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mihajlo Milojević & Petar Popović
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+# Checkers.py
+
+## Description
+
+Project for playing checkers. App supports two game modes: Single Player (player vs bot) or two players (player vs player). This project was created as project for algorithms and data structures, subject in II semestar on Faculty of tehnical science in Novi Sad using minimax algorithm with alpha-beta pruning with changing depth.
+
+## Features
+
+App allows users to player against bot or another player.
+
+Game has intutive UI that show user available moves for selected piece by marking places where piece can move with blue dot and marking jumps with green dots. Current player is marked with cyan outline.
+
+Bot is using minimax algorithm with alpha-beta pruning with changing depth.
+
+All features are specified in [project specification](./materials/Projekat%201%20v.25.03.2024..pdf)
+
+## Setup
+
+App can be started by:
+
+- activating ```main.py``` script - need access to src, assets and cache
+- using ```checkers.exe``` executable (Windows only) - need access to assets and cache
+- running ```Checkers.msi``` installer (can be downloaded from [releases](https://github.com/MihajloMilojevic/Checkers.py/releases/tag/windows))
+
+## Credits
+
+Optimal heuristic algorithm and weight are taken from [Kevin Gregor's Github](https://github.com/kevingregor/Checkers)
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Preview
+
+<figure style="display: flex; flex-direction: column; gap: 10px; align-items: center; justify-content: center">
+    <img src="./screenshots/start.PNG" alt="starting window">
+    <caption ><i>Starting window</i></caption>
+</figure>
+
+<figure style="display: flex; flex-direction: column; gap: 10px; align-items: center; justify-content: center">
+    <img src="./screenshots/game.PNG" alt="game window">
+    <caption ><i>Game window</i></caption>
+</figure>
+
+<figure style="display: flex; flex-direction: column; gap: 10px; align-items: center; justify-content: center">
+    <img src="./screenshots/moves.PNG" alt="making moves">
+    <caption ><i>Making moves</i></caption>
+</figure>
+
+<figure style="display: flex; flex-direction: column; gap: 10px; align-items: center; justify-content: center">
+    <img src="./screenshots/game_over.PNG" alt="game over window">
+    <caption ><i>Game over window</i></caption>
+</figure>