Merge branch 'master' of gitlab.laas.fr:tpillot/thymio-game

README.md

@@ -6,12 +6,18 @@ A competitive game in groups with Thymio.
 
 The game needs at least Python 3.6.
 
+Install it by running these commands (the project depends on pyqt5 so installing 
+the requirements can be quite long):
 ```bash
 git clone https://gitlab.laas.fr/tpillot/thymio-game.git
 cd thymio-game
 python -m venv venv
 . venv/bin/activate
 pip install -r requirements.txt
+```
+
+And run it with:
+```bash
 python main.py
 ```
 
@@ -33,7 +39,8 @@ the scoreboard.
 ## Scoreboard
 
 The scoreboard window has a timer, an event history, and a webcam highlighting
-detected tags in real time. 
+detected tags in real time. The webcam should be placed so that it films the place
+the Thymios have to reach in order to win points.
 
 To start the scoreboard and all Thymios at the same 
 time, you first need to press the blue start button to allow the teams to join the
@@ -41,13 +48,14 @@ automated start.
 
 ![](images/scoreboard.png)
 
-At this point, all teams have to click on the **Join activity** button which will
-first ask them to save their work.
+At this point, all teams have to click on the **Join activity** button on VPL 
+which will first ask them to save their work.
 
 ![](images/vpl.png)
 
-Then VPL should display a message saying that
-the program is waiting for the activity to start.
+Then VPL should display a message saying that the program is waiting for the activity 
+to start. VPL will be unresponsive until the activity is started.
+
 
 ![](images/vpl2.png)
 
@@ -55,3 +63,7 @@ When all the teams have this message, you can start running all Thymios at the s
 time by pressing the green start button.
 
 ![](images/scoreboard2.png)
+
+When the Thymios and the timer start running, the scoreboard is active and each
+time the webcam detects a tag, the corresponding team will win points. The amount
+of points won depends on the time taken to complete the race.