Skip to content

Commit 2d69ad2

Browse files
committed
Update Readme.md
1 parent df9c0c7 commit 2d69ad2

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contents
2+
- [Minimax AI](##Minimax-AI)
3+
- [Random AI](##Random-AI)
4+
- [Game Analytics](##Game-analytics)
5+
- [Installation](##Installing-dependencies)
6+
- [Tests](#Running-the-tests)
7+
8+
## Minimax AI
9+
Recursively finds the best move for the current Grid State
10+
11+
![Minimax in action](./Images/MinimaxDemo.gif)
12+
13+
## Random AI
14+
Randomly chooses a position
15+
16+
![Random AI in action](./Images/RandomDemo.gif)
17+
18+
## Game Analytics
19+
Displays the data stored on the Flask backend as a Pie Chart
20+
21+
![Game analytics](./Images/Analytics.png)
22+
23+
## Installing Dependencies
24+
If using `pipenv`:
25+
```
26+
pipenv shell
27+
pipenv install
28+
```
29+
30+
Else, if using `pip`:
31+
```
32+
pip install requirements.txt
33+
```
34+
35+
Afterwards, you will hopefully be able to run the program
36+
```
37+
python tictactoe.py
38+
```
39+
40+
## Running the tests
41+
This step is optional, and just tests if the core functionality is working.
42+
43+
Once you've installed the dependencies, run:
44+
```
45+
pytest
46+
```

0 commit comments

Comments
 (0)