From 461522b7adb523d2965c1527f84daf290689ba98 Mon Sep 17 00:00:00 2001
From: "McCarthy, Samuel (ITS Product Mgmt)" <s.mccarthy@surrey.ac.uk>
Date: Wed, 28 Aug 2024 15:28:18 +0000
Subject: [PATCH] Update file README.md

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2197f28
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+apptainer-build-ci
+Project containing a shared gitlab-ci.yml file for building Apptainer images.
+
+How to use
+Simply create a .gitlab-ci.yml file in your project that contains the following:
+
+include:
+  - project: 'surrey-shared-containers/templates/apptainer-build-ci'
+    file: 'apptainer-build-ci.yml'
+This will cause you project to pull and use the gitlab-ci.yml from this project.
\ No newline at end of file
-- 
GitLab