diff --git a/README.md b/README.md index fbbbd35..2de36fb 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -Dépôt pour la SAE de seconde année BUT Aix en Provence +![build status](./images/logo.png) + +___ +

A Simple deduction game based on facial reactions

+ +![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 diff --git a/images/Interogation.png b/images/Interogation.png new file mode 100644 index 0000000..395c049 Binary files /dev/null and b/images/Interogation.png differ diff --git a/images/debrief.png b/images/debrief.png new file mode 100644 index 0000000..d7a96e1 Binary files /dev/null and b/images/debrief.png differ diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..a17afd6 Binary files /dev/null and b/images/logo.png differ diff --git a/images/title.png b/images/title.png new file mode 100644 index 0000000..bb73735 Binary files /dev/null and b/images/title.png differ