improve documentation

Carlos Picanco
1 parent 8f4203c4
Showing 3 changed files with 13 additions and 13 deletions Show diff stats
docs/INSTALL/manual_en.md
docs/INSTALL/manual_pt_br.md
experiment_runner/units/game_file_methods.pas
@@ -42,7 +42,6 @@
  
    1. Install Lazarus RAD IDE (v1.6.2+) Free Pascal compiler and sources (v3.0.0+): http://lazarus-ide.org/.
    2. Compile and install libzmq (v3.2.5) on your system: http://zeromq.org/intro:get-the-software.
-   3. Install epiktimer 
  
    Note: If windows, all sofware must be compiled for 32bits, otherwise, you must write 64bits support yourself.
  
@@ -38,14 +38,16 @@
     3.4 - Utilização.
       3.4.1 - Em um único computador.
       3.4.2 - Em uma rede local.
+
   4 - Problemas conhecidos e soluções.
+
     4.1 - Uma referência foi retornada do servidor.
  
   5 - Referências.
  
 ## 1. Introdução
  
-  Free-mtrix (v1.0.0) é um sistema que permite o planejamento e a apresentação de experimentos sociais baseados em tarefas similares àquelas apresentadas por Vich, Andery e Glenn (2009). Ele é composto por dois programas de computador. O programa `Designer` é usado para o planejamento e o programa `Runner` para a apresentação de experimentos.  
+  Free-mtrix é um sistema que permite o planejamento e a apresentação de experimentos sociais baseados em tarefas similares àquelas utilizadas por Vich, Andery e Glenn (2009). Ele é composto por dois programas de computador. O programa `Designer` é usado para o planejamento e o programa `Runner` para a apresentação de experimentos.  
  
 ## 2. Designer
  
@@ -71,26 +73,25 @@
  
 #### 2.3.2. Sistemas Operacionais Linux
  
-  Nos sistemas operacionais Linux, o programa `Designer` é executado por meio do arquivo `experiment_designer`, localizado na pasta `experiment_designer`. Recomenda-se a execução no Debian 8, 32 ou 64 bits.
+  Nos sistemas operacionais Linux, o programa `Designer` é executado por meio do arquivo `experiment_designer`, localizado na pasta `experiment_designer`. Recomenda-se a execução no Debian 8, 64 bits.
  
 ### 2.4. Utilização
  
-  O programa `Designer` é usado para o planejamento de experimentos sociais por meio do preenchimento de um formulário pelo pesquisador. O formulário é curto (~10 min) e utiliza a terminologia do campo de estudos chamado "Análise do Comportamento", tornando-o intuitivo aos pesquisadores da área. Todo o processo de preenchimento é salvo automaticamente. Ao final, um arquivo de configuração do experimento é disponibilizado para uso, reuso, arquivamento ou edição.
+  O programa `Designer` permite o planejamento de experimentos sociais por meio do preenchimento de um formulário pelo pesquisador. O formulário é curto (~10 min) e utiliza a terminologia do campo de estudos chamado "Análise do Comportamento", tornando-o intuitivo aos pesquisadores da área. Todo o processo de preenchimento é salvo automaticamente. Ao final, um arquivo de configuração do experimento é disponibilizado para uso, reuso, arquivamento ou edição.
  
 ## 3. Runner
  
 ### 3.1 Instalação
  
-  O programa `Runner` é uma aplicação auto-executável e não necessita de instalação. Entretanto, o programa `Runner` depende da instalação da biblioteca `libzmq` (http://zeromq.org/). Uma cópia da biblioteca libzmq é distribuida com o Free-mtrix. Confira a seguir como instalar a biblioteca no seu sistema.
+  O programa `Runner` é uma aplicação auto-executável e não necessita de instalação. Entretanto, o programa `Runner` depende da biblioteca `libzmq` (http://zeromq.org/). Uma cópia da biblioteca libzmq é distribuida com o Free-mtrix, mas ela necessita ser instalada. Confira a seguir como instalar a biblioteca no seu sistema.
  
 #### 3.1.1. libzmq no Windows
  
 Siga os passos a seguir para instalar a biblioteca libzmq no Windows 10.
  
   1. Baixe e instale o `Visual C++ Redistributable for Visual Studio 2015`. Você pode encontrá-lo aqui: https://www.microsoft.com/en-us/download/details.aspx?id=48145
-  2. Copie o arquivo `libzmq.dll` distribuido com este (v3.2.5, 32bits, dinâmica, compilada com o VS 2015).
-    - Alternativamente, você mesmo pode construir a biblioteca seguindo as instruções aqui: http://zeromq.org/intro:get-the-software#toc8.
-  3. Cole o arquivo `libzmq.dll` dentro da pasta `experiment_runner`. A pasta deve conter o arquivo executável `experiment_runner.exe`. 
+  2. O arquivo `libzmq.dll` é distribuido com este programa, localizado na pasta `experiment_runner`, a mesma pasta que contém o arquivo `experiment_runner.exe`. 
+    - Alternativamente, caso não queira usar o arquivo distribuido, você mesmo pode construir a biblioteca `libzmq.dll` seguindo as instruções aqui: http://zeromq.org/intro:get-the-software#toc8. Em seguida, basta copiá-la para o mesmo local do arquivo `experiment_runner.exe`. 
   4. Pronto!
  
 #### 3.1.2. libzmq em Sistemas Operacionais Linux
@@ -126,19 +127,19 @@ Siga os passos a seguir para instalar a biblioteca libzmq em sistemas Linux.
  
 #### 3.3.3. Observações para todos os sistemas
  
-  - Se você possui um firewall ligado, you necessitará criar uma regra adicionando o programa como uma exceção.
+  - Se você possui um firewall ligado, você necessitará criar uma regra adicionando o programa como uma exceção.
  
   - Você necessitará de uma instância do programa sendo executada como Servidor (Pesquisador) antes de executar instâncias como Clientes (Participantes). O programa funciona com no mínimo 2 clientes.
  
 ### 4. Utilização
  
-  Por meio da leitura de arquivos de configuração válidos (gerados pelo programa "Designer" ou não), o programa `Runner` é usado para a apresentação de experimentos aos participantes de uma pesquisa. Um chat integrado ao programa, se habilitado no arquivo de configuração, permite a interação entre os participantes por meio de texto. Os participantes devem ser instruidos a realizar uma tarefa de escolha apresentada pelo programa. O registro das escolhas e da interação é automático e em tempo real. O programa pode ser executado em um único computador, para testes e debug por exemplo, ou pode ser facilmente configurado em uma rede local com múltiplos computadores.
+  O programa `Runner` é usado para a apresentação de experimentos aos participantes de uma pesquisa por meio da leitura de arquivos de configuração válidos, gerados pelo programa "Designer" ou não. Um chat integrado ao programa, se habilitado no arquivo de configuração, permite a interação entre os participantes por meio de texto. Os participantes devem ser instruidos a realizar a tarefa de escolha apresentada pelo programa. O registro das escolhas e da interação é automático e em tempo real. O programa pode ser executado em um único computador, para testes e debug por exemplo, ou pode ser facilmente configurado em uma rede local com múltiplos computadores.
  
-  O programa `Runner` possui seu próprio servidor e cliente embarcados. Veja seguir como executar diferentes instâncias do programa como servidor e cliente.
+  O programa `Runner` possui seu próprio servidor e cliente embarcados. Veja a seguir como executar diferentes instâncias do programa como servidor e cliente.
  
 #### 3.4.1. - Em um único computador
  
-  O exemplo a seguir assume que uma instância do programa será executada como um servidor, e três instâncias como participantes em uma mesma máquina. Também se assume a existência de um arquivo de configuração chamado `experimento_x.ini`, um experimento de nome `Experimento_X` configurado para 3 participantes e feito por um pesquisador de nome `Pesquisador_X`.
+  O exemplo a seguir assume que uma instância do programa será executada como um servidor e três instâncias como participantes em uma mesma máquina. Também se assume a existência de um arquivo de configuração chamado `experimento_x.ini`, um experimento de nome `Experimento_X` configurado para 3 participantes e feito por um pesquisador de nome `Pesquisador_X`.
  
   1. Instale a biblioteca libzmq na máquina alvo.
   2. Copie o executável `experiment_runner` para diferentes pastas (se Windows, também copie a biblioteca `libzmq`). Por exemplo, no Linux a estrutura de arquivos ficaria assim:
@@ -432,7 +432,7 @@ begin
  
             MI := 0;
             CI := 0;
-            for j := 0 to High(Contingencies) do // write ocntingencies
+            for j := 0 to High(Contingencies) do // write contingencies
               begin
                 if Contingencies[j].Meta then
                   begin
...	...	@@ -42,7 +42,6 @@
42	42
43	43	1. Install Lazarus RAD IDE (v1.6.2+) Free Pascal compiler and sources (v3.0.0+): http://lazarus-ide.org/.
44	44	2. Compile and install libzmq (v3.2.5) on your system: http://zeromq.org/intro:get-the-software.
45		- 3. Install epiktimer
46	45
47	46	Note: If windows, all sofware must be compiled for 32bits, otherwise, you must write 64bits support yourself.
48	47
...	...
...	...	@@ -38,14 +38,16 @@
38	38	3.4 - Utilização.
39	39	3.4.1 - Em um único computador.
40	40	3.4.2 - Em uma rede local.
	41	+
41	42	4 - Problemas conhecidos e soluções.
	43	+
42	44	4.1 - Uma referência foi retornada do servidor.
43	45
44	46	5 - Referências.
45	47
46	48	## 1. Introdução
47	49
48		- Free-mtrix (v1.0.0) é um sistema que permite o planejamento e a apresentação de experimentos sociais baseados em tarefas similares àquelas apresentadas por Vich, Andery e Glenn (2009). Ele é composto por dois programas de computador. O programa `Designer` é usado para o planejamento e o programa `Runner` para a apresentação de experimentos.
	50	+ Free-mtrix é um sistema que permite o planejamento e a apresentação de experimentos sociais baseados em tarefas similares àquelas utilizadas por Vich, Andery e Glenn (2009). Ele é composto por dois programas de computador. O programa `Designer` é usado para o planejamento e o programa `Runner` para a apresentação de experimentos.
49	51
50	52	## 2. Designer
51	53
...	...	@@ -71,26 +73,25 @@
71	73
72	74	#### 2.3.2. Sistemas Operacionais Linux
73	75
74		- Nos sistemas operacionais Linux, o programa `Designer` é executado por meio do arquivo `experiment_designer`, localizado na pasta `experiment_designer`. Recomenda-se a execução no Debian 8, 32 ou 64 bits.
	76	+ Nos sistemas operacionais Linux, o programa `Designer` é executado por meio do arquivo `experiment_designer`, localizado na pasta `experiment_designer`. Recomenda-se a execução no Debian 8, 64 bits.
75	77
76	78	### 2.4. Utilização
77	79
78		- O programa `Designer` é usado para o planejamento de experimentos sociais por meio do preenchimento de um formulário pelo pesquisador. O formulário é curto (~10 min) e utiliza a terminologia do campo de estudos chamado "Análise do Comportamento", tornando-o intuitivo aos pesquisadores da área. Todo o processo de preenchimento é salvo automaticamente. Ao final, um arquivo de configuração do experimento é disponibilizado para uso, reuso, arquivamento ou edição.
	80	+ O programa `Designer` permite o planejamento de experimentos sociais por meio do preenchimento de um formulário pelo pesquisador. O formulário é curto (~10 min) e utiliza a terminologia do campo de estudos chamado "Análise do Comportamento", tornando-o intuitivo aos pesquisadores da área. Todo o processo de preenchimento é salvo automaticamente. Ao final, um arquivo de configuração do experimento é disponibilizado para uso, reuso, arquivamento ou edição.
79	81
80	82	## 3. Runner
81	83
82	84	### 3.1 Instalação
83	85
84		- O programa `Runner` é uma aplicação auto-executável e não necessita de instalação. Entretanto, o programa `Runner` depende da instalação da biblioteca `libzmq` (http://zeromq.org/). Uma cópia da biblioteca libzmq é distribuida com o Free-mtrix. Confira a seguir como instalar a biblioteca no seu sistema.
	86	+ O programa `Runner` é uma aplicação auto-executável e não necessita de instalação. Entretanto, o programa `Runner` depende da biblioteca `libzmq` (http://zeromq.org/). Uma cópia da biblioteca libzmq é distribuida com o Free-mtrix, mas ela necessita ser instalada. Confira a seguir como instalar a biblioteca no seu sistema.
85	87
86	88	#### 3.1.1. libzmq no Windows
87	89
88	90	Siga os passos a seguir para instalar a biblioteca libzmq no Windows 10.
89	91
90	92	1. Baixe e instale o `Visual C++ Redistributable for Visual Studio 2015`. Você pode encontrá-lo aqui: https://www.microsoft.com/en-us/download/details.aspx?id=48145
91		- 2. Copie o arquivo `libzmq.dll` distribuido com este (v3.2.5, 32bits, dinâmica, compilada com o VS 2015).
92		- - Alternativamente, você mesmo pode construir a biblioteca seguindo as instruções aqui: http://zeromq.org/intro:get-the-software#toc8.
93		- 3. Cole o arquivo `libzmq.dll` dentro da pasta `experiment_runner`. A pasta deve conter o arquivo executável `experiment_runner.exe`.
	93	+ 2. O arquivo `libzmq.dll` é distribuido com este programa, localizado na pasta `experiment_runner`, a mesma pasta que contém o arquivo `experiment_runner.exe`.
	94	+ - Alternativamente, caso não queira usar o arquivo distribuido, você mesmo pode construir a biblioteca `libzmq.dll` seguindo as instruções aqui: http://zeromq.org/intro:get-the-software#toc8. Em seguida, basta copiá-la para o mesmo local do arquivo `experiment_runner.exe`.
94	95	4. Pronto!
95	96
96	97	#### 3.1.2. libzmq em Sistemas Operacionais Linux
...	...	@@ -126,19 +127,19 @@ Siga os passos a seguir para instalar a biblioteca libzmq em sistemas Linux.
126	127
127	128	#### 3.3.3. Observações para todos os sistemas
128	129
129		- - Se você possui um firewall ligado, you necessitará criar uma regra adicionando o programa como uma exceção.
	130	+ - Se você possui um firewall ligado, você necessitará criar uma regra adicionando o programa como uma exceção.
130	131
131	132	- Você necessitará de uma instância do programa sendo executada como Servidor (Pesquisador) antes de executar instâncias como Clientes (Participantes). O programa funciona com no mínimo 2 clientes.
132	133
133	134	### 4. Utilização
134	135
135		- Por meio da leitura de arquivos de configuração válidos (gerados pelo programa "Designer" ou não), o programa `Runner` é usado para a apresentação de experimentos aos participantes de uma pesquisa. Um chat integrado ao programa, se habilitado no arquivo de configuração, permite a interação entre os participantes por meio de texto. Os participantes devem ser instruidos a realizar uma tarefa de escolha apresentada pelo programa. O registro das escolhas e da interação é automático e em tempo real. O programa pode ser executado em um único computador, para testes e debug por exemplo, ou pode ser facilmente configurado em uma rede local com múltiplos computadores.
	136	+ O programa `Runner` é usado para a apresentação de experimentos aos participantes de uma pesquisa por meio da leitura de arquivos de configuração válidos, gerados pelo programa "Designer" ou não. Um chat integrado ao programa, se habilitado no arquivo de configuração, permite a interação entre os participantes por meio de texto. Os participantes devem ser instruidos a realizar a tarefa de escolha apresentada pelo programa. O registro das escolhas e da interação é automático e em tempo real. O programa pode ser executado em um único computador, para testes e debug por exemplo, ou pode ser facilmente configurado em uma rede local com múltiplos computadores.
136	137
137		- O programa `Runner` possui seu próprio servidor e cliente embarcados. Veja seguir como executar diferentes instâncias do programa como servidor e cliente.
	138	+ O programa `Runner` possui seu próprio servidor e cliente embarcados. Veja a seguir como executar diferentes instâncias do programa como servidor e cliente.
138	139
139	140	#### 3.4.1. - Em um único computador
140	141
141		- O exemplo a seguir assume que uma instância do programa será executada como um servidor, e três instâncias como participantes em uma mesma máquina. Também se assume a existência de um arquivo de configuração chamado `experimento_x.ini`, um experimento de nome `Experimento_X` configurado para 3 participantes e feito por um pesquisador de nome `Pesquisador_X`.
	142	+ O exemplo a seguir assume que uma instância do programa será executada como um servidor e três instâncias como participantes em uma mesma máquina. Também se assume a existência de um arquivo de configuração chamado `experimento_x.ini`, um experimento de nome `Experimento_X` configurado para 3 participantes e feito por um pesquisador de nome `Pesquisador_X`.
142	143
143	144	1. Instale a biblioteca libzmq na máquina alvo.
144	145	2. Copie o executável `experiment_runner` para diferentes pastas (se Windows, também copie a biblioteca `libzmq`). Por exemplo, no Linux a estrutura de arquivos ficaria assim:
...	...
...	...	@@ -432,7 +432,7 @@ begin
432	432
433	433	MI := 0;
434	434	CI := 0;
435		- for j := 0 to High(Contingencies) do // write ocntingencies
	435	+ for j := 0 to High(Contingencies) do // write contingencies
436	436	begin
437	437	if Contingencies[j].Meta then
438	438	begin
...	...