diff --git a/README.md b/README.md index 05af97a64f5dbb1d98c8a4bbf6c921c094e3e5a4..d720c5e833fd049d9b0ca8d46aa0aa35c6b788d0 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,10 @@ Studio. 3. Run `make` to build the project (use `make -j N` if you want to use N threads) +# How to use the library with PyCharm + +See [separate page](pycharm.md). + # 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 diff --git a/pycharm.md b/pycharm.md new file mode 100644 index 0000000000000000000000000000000000000000..44c2b360f44029f1d7ae5d58c8102c920eba73d3 --- /dev/null +++ b/pycharm.md @@ -0,0 +1,13 @@ +# Installing PyCommandCenter in PyCharm + +Start of by download the library from the [PyCommandCenter repository](https://gitlab.ida.liu.se/starcraft-api/pycommandcenter/tags). + +Place the library in your repository. + +Add the library to the Python path in Python by: + +1. File->Settings->Project: (project name)->Project Interpreter +2. Select the cog in the upper right corner and select "Show All" +3. In the new window that opens select the icon which shows a few folders connected with lines +4. In the new window press the plus icon and select the path of your repository (should be where you placed the library) +5. Restart PyCharm with File->Invalidate Caches/Restart->Invalidate and Restart