diff --git a/README.md b/README.md index 294b963160d4d635dcefcdea05a52bf0ab9e00f2..acd957b4eb7c923c7eda5126668182951d864f61 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,8 @@ First you need to make sure you got all the build dependencies: Now, you are ready to build the python library: -1. Run `git clone --recurse-submodules - https://gitlab.ida.liu.se/davbe125/s2-python-api.git` in order to get the - code and all its dependencies +1. Open up a terminal, download the source code using the command: + `git clone --recurse-submodules https://gitlab.ida.liu.se/davbe125/s2-python-api.git` 2. Next, open the repository in your file viewer and run the batch script called `create-visual-studio-solution.bat` in order to use cmake to create a Visual studio solution @@ -42,6 +41,19 @@ Now, you are ready to build the python library: file. The file will be located at `build\python-api-src\Release` and its name will depend on the python version used. +# How to build (Linux, untested) + +Same dependencies applies as for Windows, although you don't need Visual +Studio. + +1. Open up a terminal, download the source code using the command: `git clone + --recurse-submodules https://gitlab.ida.liu.se/davbe125/s2-python-api.git` +2. Next, enter the directory and run the command `mkdir build` followed by `cd + build` and `cmake ..` in order to create the makefiles needed for building the + library. +3. Run `make` to build the project (use `make -j N` if you want to use N + threads) + # Credits CommandCenter is written by [David Churchill](http://www.cs.mun.ca/~dchurchill/), Assistant Professor of [Computer Science](https://www.cs.mun.ca/) at Memorial University, and organizer of the [AIIDE StarCraft AI