From fc5182a427309c10270f33354209347cf825693c Mon Sep 17 00:00:00 2001
From: Lukas Werner <lks.werner@fau.de>
Date: Tue, 8 Jun 2021 06:07:55 +0000
Subject: [PATCH] Update README.md

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 3521b29..4875cde 100644
--- a/README.md
+++ b/README.md
@@ -11,4 +11,9 @@ First, the username to authenticate with has to be set using the `AUTH_USER` var
 Second, a key pair has to be generated, of which the private key is added as a CI variable `AUTH_KEY` in reposity settings > CI/CD.
 The public one has to be added to `~/gitlab-runner/authorized_keys`, where `~` signifies the `AUTH_USER`'s home. 
 
+Jobs, which have the variable `SUBMIT_TO_SLURM` set, will have their `script` submitted to SLURM. 
+Options for SLURM's `salloc` are configurable by setting the respective environment variables preceded by `SLURM_` in the `variables` section of the job definition.
+
+Jobs without `SUBMIT_TO_SLURM` will have their `script` executed on the frontend of the cluster.
+
 An example `.gitlab-ci.yml` file can be found in the root of this repository. 
-- 
GitLab