docs: update readme

AresSC2 · Jul 3, 2023 · e07d944 · e07d944
1 parent 422c571
commit e07d944
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,11 @@ Open up `bot/main.py` and have fun!
 A `ares-sc2` bot is a [python-sc2](https://github.com/BurnySc2/python-sc2) bot by default, so any examples or
 documentation in that repo will be relevant here too.
 
+### Uploading to [AiArena](https://www.sc2ai.com)
+Included in the repository is a convenient script named `scripts/create_ladder_zip.py`. However, it is important to note that the AIarena ladder infrastructure operates specifically on Linux-based systems. Due to the dependency of ares-sc2 on cython, it is necessary to execute this script on a Linux environment in order to generate Linux binaries.
+
+To streamline this process, a GitHub workflow has been integrated into this repository. Upon each push to the main branch, the `create_ladder_zip.py` script is automatically executed on a Debian-based system. As a result, a compressed artifact named `ladder-zip.zip` is generated, facilitating the subsequent upload to AIarena. To access the generated file, navigate to the Actions tab and refer to the Artifacts section.
+
 ### PyCharm
 
 #### Adding `poetry` environment