Merge branch 'main' of github.com:SFI-Visual-Intelligence/Collaborative-Coding-Exam into mag-branch

Author: Seilmast

README.md

@@ -2,3 +2,27 @@
 
 # Collaborative-Coding-Exam
 Repository for final evaluation in the FYS-8805 Reproducible Research and Collaborative coding course
+
+## Usage
+
+TODO: Fill in
+
+### Running on a k8s cluster
+
+In your job manifest, include:
+
+```yaml
+# ...
+spec:
+  template:
+    spec:
+      containers:
+        - name: some-container-name
+          image: "ghcr.io/sfi-visual-intelligence/collaborative-coding-exam:main"
+          # ...
+```
+
+to pull the latest build, or check the [packages](https://github.com/SFI-Visual-Intelligence/Collaborative-Coding-Exam/pkgs/container/collaborative-coding-exam), for earlier versions.
+
+> [!NOTE]
+> The container is build for a `linux/amd64` architecture to properly build Cuda 12. For other architectures please build the docker image locally.