diff --git a/README.md b/README.md index 1c51bb8..5fc3b9a 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,18 @@ Forgejo instance serving https://forge.karnov.club. -## Maintaining +## Usage + +### Starting the Forgejo instance Using [spud](https://forge.karnov.club/spadinastan/spud), just `spud start ./service.yml`! ### Starting runners +Runner metadata (i.e. version, per-instance configuration) is defined under `metadata.json`. + +Before starting the runners, they should be registered via `RUNNER_HOME=... ./runners.py register`. An interactive prompt needs to be filled for each runner to enter details and tokens. + ``` -./runners.py start +RUNNER_HOME= ./runners.py start ```