From b65a9fb10ea24052269dabc392aad0f9151bd220 Mon Sep 17 00:00:00 2001
From: "Mulas, Giacomo" <gmulas@oa-cagliari.inaf.it>
Date: Thu, 18 Jan 2024 16:43:35 +0100
Subject: [PATCH] add README.md file

---
 containers/docker/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 containers/docker/README.md

diff --git a/containers/docker/README.md b/containers/docker/README.md
new file mode 100644
index 00000000..3eb7fa8c
--- /dev/null
+++ b/containers/docker/README.md
@@ -0,0 +1,12 @@
+# Docker support for the NP-TMcode project
+
+This Dockerfile allows to create mainly:
+
+- the np-tmcode image that is used by the gitlab pipeline runner to test compile and execution of requested merges
+- the np-tmcode-run image, that contains only the pre-built executables, python test scripts, compiled documentation, and the minimal runtime to run them
+
+In order for the docker build to correctly set the context, so that it can access the directories containing source codes, docker build must be invoked from this directory as:
+
+   > docker build -f Dockerfile ../.. --target <image name>
+
+where `<image name>` is either `np-tmcode` or `np-tmcode-run`. One may also add the docker build option `-t tagname` to specify the `tagname` the built image should have in his/her registry.
\ No newline at end of file
-- 
GitLab