Read Me

README ======   LINHA DO TEXTO SEMIOTIC CLASSIFIER GAME ================

1. INTRODUCTION

This game works comparing the avaliation of some texts and parameters, previously selected.
For example:
you have the colors blue and red inside texts:

title: blue A
text: The sky is blue today.

title: blue B
text: I like blue songs.

title: red
text: Aples are red.

If the parameters are exact/similar and colour/efect, people will click in each title and, reading the whole text, will vote about what parameter is near from the sense of the text, in a scale from 1 to 9 colours.

Every vote is writing in a mysql database and the game returns the average of votes in order to put the title distributed in the line of texts (linha do texto) conforming the votes.

The game can be used to explain certains theorectical concepts as well as to research about contente sense of texts.

2. HOW TO INSTALL

a) You must to copy the directory linhadotexto in a php/mysql server.

b) open the config.php file in order to replace the data about database and password. Save it.

c) Create the database linhadotexto linked to the username you had created for it. The database must contain 4 tables, without data:

- jogo >> 3 fields: id_jogo (int(11), not_null, auto_increment), jogo (varchar(100), latin1_swedish_ci, not_null) and email (varchar(100), latin1_swedish_ci, not_null)

- parametro >> 4 fields: id_parametro (int(11), not_null, auto_increment), id_jogo (int(11), not_null), parametroa (varchar(100), latin1_swedish_ci, not_null) and parametrob (varchar(100), latin1_swedish_ci, not_null)

- texto >> 4 fields: id_texto (int(11), not_null, auto_increment), id_jogo (int(11), not_null), titulo (varchar(100), latin1_swedish_ci, not_null) and texto (varchar(100), latin1_swedish_ci, not_null)

- voto >> 4 fields: id_voto (int(11), not_null, auto_increment), id_jogo (int(11), not_null), id_texto  (int(11), not_null) and voto  (int(11), not_null)

Then it is ready for using.

3. HOW TO CREATE A GAME

- The initial page is the index.php.
- Go to "Cadastro de Jogos".
- Authenticate using the password for creating games (it is in the config.php file).
- Put the required data: the valid e-mail address, texts and parameters.
- Click on "Salvar".

EDIT/DISPOSE NEW TEXTS OR PARAMETERS:
- Click on "Cadastro de Jogos".
- Find the game you want to edit, then click on "Editar".
- Edit the game's general data, texts or parameters.
- Click on "Salvar".

Your game is ready! Go to the page "Lista de jogos" in order to initiate the game.

4. HOW TO PLAY

Read the INTRODUCTION on "Orientações".

5. NOTES

This project has a list of Docker files (Dockerfile and docker-compose.yml). If you know how Docker works, you may just run the command bellow to run the app locally:

```bash
$ docker-compose up
```

6. TO DO

- The game is in Brazilian Portuguese and the language is hard coded yet, but we have planned to make a language file for future translations.