First you need to make sure you got all the build dependencies:
* cmake
* Visual Studio 2017 or later (earlier might work, but untested)
* cmake, installed at C:\Program Files\CMake
* Visual Studio 2022
* git
* python 3.7 or later (earlier might work, but untested)
* python 3.12
If you ever want to make any changes to the library, e.g. adding new features or making bug fixes, it's easier to fork the project before cloning the repository. For instructions on how to fork, see [the gitlab documentation](https://gitlab.liu.se/help/gitlab-basics/fork-project.md).
...
...
@@ -74,17 +74,8 @@ Now, you are ready to build the python library:
1. Open up a terminal, download the source code using the command: `git clone --recurse-submodules https://gitlab.liu.se/starcraft-ai-course/pycommandcenter.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
3. Open the Visual Studio solution located in the newly created directory
`build/`
4. The project called `library` should be selected as the default StartUp
project in the Solution Explorer (on the right side by default)
5. Change settings to Release and x64
6. Click "Local Windows Debugger" and it will start compiling
7. Visual Studio will open an error message telling you it cannot open the
resulting library file, which means it **successfully** created the library
file. The file will be located at `build\python-api-src\Release` and its
called `create-visual-studio-solution.bat`.
3. 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)
...
...
@@ -130,7 +121,7 @@ See [separate page](pycharm.md).
of the resulting `pyd` file
5. Build the documentation:
* If you are using Windows, open a terminal, navigate to the docs/ folder
and run the command `make.bat html`.
and run the command `python -m sphinx . _build` (alternatively: `make.bat html`).
* If you are using Linux, open a terminal, navigate to the docs/ folder and