Commit 992809a63f1a7e8cf33ba7e4263d892d4a2531a1
1 parent
bd0115e9
Exists in
master
update READMe
Showing
1 changed file
with
23 additions
and
7 deletions
Show diff stats
README.md
| 1 | 1 | # lacs-matrix |
| 2 | 2 | |
| 3 | -- How to install? | |
| 3 | +## How to install? | |
| 4 | 4 | |
| 5 | -No need for installation. Just run the executable. | |
| 5 | +### Windows | |
| 6 | 6 | |
| 7 | -- How to setup? | |
| 7 | + 1. Download and install Visual C++ Redistributable for Visual Studio 2015. You may find it here: https://www.microsoft.com/en-us/download/details.aspx?id=48145 | |
| 8 | 8 | |
| 9 | -You have at least two options. | |
| 9 | + 2. Copy the `libzmq.dll` (v3.2.5, 32bits, dynamic, compiled with VS 2015) library to the same folder as the `cultural_matrix.exe` file. | |
| 10 | 10 | |
| 11 | -1. Running from different folders in a machine (default for debugging). | |
| 12 | -2. Running from different machines in a local network. | |
| 11 | +### Linux | |
| 13 | 12 | |
| 14 | -You will need an instance of the program acting as a Server (researcher) and others acting as Clients (players). Clients must connect to the IP address of the Server; just create a file called 'IP' in the root folder of each client containing the Server IP on the first line. | |
| 13 | + 1. Install libzmq.so, v3.2.5, 64 or 32 bits, on your system. | |
| 15 | 14 | |
| 15 | +## How to setup? | |
| 16 | 16 | |
| 17 | + - You have at least two options. | |
| 18 | + 1. Running from different folders in one machine (default for debugging). | |
| 19 | + 2. Running from different machines in a local network. | |
| 20 | + | |
| 21 | + - If you have a firewall enabled, you must create a firewall rule adding the program as an exception. | |
| 22 | + | |
| 23 | + - You will need an instance of the program running as Server (researcher) and others running as Clients (players). You will need at least two clients. | |
| 24 | + | |
| 25 | + - Clients must connect to the IP address of the Server; just create a file named 'IP' in the root folder of each client containing the Server IP on the first line. | |
| 26 | + | |
| 27 | +## Known Issues | |
| 28 | + | |
| 29 | +**`A referral was returned from the server`** | |
| 30 | + | |
| 31 | + - Windows Only Error. | |
| 32 | + - Solution 1: Right click at the `.exe` and select properties. In the tab compatibility, check the checkbox "Run as administrator". | |
| 17 | 33 | \ No newline at end of file | ... | ... |