added readme content

This commit is contained in:
Djalim Simaila 2023-01-15 13:57:37 +01:00
parent e2b6336507
commit 02c7ea6bbc
5 changed files with 25 additions and 1 deletions

View File

@ -1 +1,25 @@
Dépôt pour la SAE de seconde année BUT Aix en Provence ![build status](./images/logo.png)
___
<p align="center"> A Simple deduction game based on facial reactions </p>
![build status](https://github.com/ThomasRubini/SAE-A2-TruthInquiry/actions/workflows/tests.yml/badge.svg)
## Screenshots
![title](./images/title.png)
![interrogation](./images/Interogation.png)
![debrief](./images/debrief.png)
___
## How to run
In ordre to run the server you will need ```python3``` and ```python3-pip```.
Then yo install the depedencies run ```pip install -r requirement.txt```.
If you want to contribute you may install the dev dependecies as well : ```pip install -r dev-requirement.txt```
To launch the web server just run the command ```flask run```
To run the test run the command ```python -m pytest --verbose```
## Contributors

BIN
images/Interogation.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

BIN
images/debrief.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 191 KiB

BIN
images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

BIN
images/title.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 424 KiB