diff --git a/README.md b/README.md index ff54654..933485e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ # lacs-matrix -- How to install? +## How to install? -No need for installation. Just run the executable. +### Windows -- How to setup? + 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 -You have at least two options. + 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. -1. Running from different folders in a machine (default for debugging). -2. Running from different machines in a local network. +### Linux -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. + 1. Install libzmq.so, v3.2.5, 64 or 32 bits, on your system. +## How to setup? + - You have at least two options. + 1. Running from different folders in one machine (default for debugging). + 2. Running from different machines in a local network. + + - If you have a firewall enabled, you must create a firewall rule adding the program as an exception. + + - 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. + + - 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. + +## Known Issues + +**`A referral was returned from the server`** + + - Windows Only Error. + - Solution 1: Right click at the `.exe` and select properties. In the tab compatibility, check the checkbox "Run as administrator". \ No newline at end of file -- libgit2 0.21.2