[CI] Add Github build pipeline (#1688)

1 files changed, 7 insertions, 0 deletions

diff --git a/README.md b/README.md
index d30aa96b6..f591edc23 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,13 @@ Official Discord: https://discord.com/invite/BtBmd55HVH
 
 Refer to the [building instructions](BUILDING.md) to compile SoH.
 
+## Getting CI to work on your fork
+
+The CI works via [Github Actions](https://github.com/features/actions) where we mostly make use of machines hosted by Github; except for the very first step of the CI process called "Extract assets". This steps extracts assets from the game file and generates an "assets" folder in `soh/`.
+
+To get this step working on your fork, you'll need to add a machine to your own repository as a self-hosted runner via "Settings > Actions > Runners" in your repository settings. If you're on macOS or Linux take a look at `macports-deps.txt` or `apt-deps.txt` to see the dependencies expected to be on your machine. For Windows, deps get installed as part of the CI process. To setup your runner as a service read the docs [here](https://docs.github.com/en/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service?platform=linux).
+
+
 ## Troubleshooting The Exporter
 - Confirm that you have an `/assets` folder filled with XMLs in the same directory as OTRGui.exe
 - Confirm that `zapd.exe` exists in the `/assets/extractor` folder