Skip to content

Commit

Permalink
Update README, resize images
Browse files Browse the repository at this point in the history
  • Loading branch information
shakram02 committed Nov 1, 2018
1 parent 43ae2a0 commit 9f051d8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,35 @@ Pi Floor has three main modules
- Optical Character Recognition (OCR) provided by Google's vision API (soon MLKit)
- User Interface a website that's hosted on the phone used to display questions on a projection screen for example (or other device)
- Http and Web Socket server, for communication between user interface and application logic
<br>
<img src="img/AppDesign.png" alt="AppDesign"/>

## How it works

Detailed description about setup and usage checkout the [poster](Pi_Floor_Poster.pdf)

- Put the grid tiles on the floor, where each tiles contains an English word
![tiles](img/tiles.jpg =250x250)
- Put the grid tiles on the floor, where each tiles contains an English word
<br>
<img src="img/tiles.jpg" alt="tiles" width="400" height="239"/>

- Enter calibration mode and select correct text on the tiles that appear on the screen
![Calibration](img/grid_calibration.png =150x250)
<br>
<img src="img/grid_calibration.png" alt="Calibration" width="360" height="390"/>
- Enter game mode, start the web server
![Game](img/game_mode_reduced.jpg =250x150)
<br>
<img src="img/game_mode_reduced.jpg" alt="GameMode" width="320" height="325"/>
- Access the given URL in game mode
![HomePage](img/home_page.jpg =250x150)
<br>
<img src="img/home_page.jpg" alt="HomePage" width="240" height="215"/>
- Upload a file containing questions and answers on the following format
![sample](sample_question.txt)

```
Question?answer,choice0,choice1,choice2,choice3,...etc
```
- Students stand on the tile to mark the answer they want
![GameRunning](img/questions_page.jpg)
<br>
<img src="img/questions_page.jpg" alt="GameRunning" width="260" height="320"/>

# Thank You

Expand Down
Binary file added img/AppDesign.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9f051d8

Please sign in to comment.