aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Rendina <rendinam@users.noreply.github.com>2020-06-10 16:22:17 -0400
committerGitHub <noreply@github.com>2020-06-10 16:22:17 -0400
commiteb82b114e2e5224770d1af0fd56a45e3fa2466fe (patch)
tree6271128c94bd62eeff41395b5466532775b10591
parentced6aa43b1cc9790c82bc07254b1a684d4e01980 (diff)
downloaddocker-buildsys-pipeline-eb82b114e2e5224770d1af0fd56a45e3fa2466fe.tar.gz
Docs (#2)
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..129ed88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Files which may be used to build a Centos docker image containing the package set found in a
+published (H)CALDP pipeline environment.
+
+#### Example use:
+
+```
+$ ./build [TAG] [Pipeline_snapshot_URL]
+```
+
+i.e.
+```
+$ ./build atodsat_RC1 https://ssb.stsci.edu/astroconda-releases/caldp/atodsat/latest-linux.yml
+
+```
+
+For the RC1 delivery iteration of the not-yet-finalized 'atodsat' calibration environment delivery set.
+
+Where:
+* `TAG` is the image tag to be appended to astroconda/buildsys-pipeline:
+* `Pipeline_snapshot_URL` is the URL where a published (H)CALDP delivery snapshot YAML file may be found.
+
+In-progress and finalized pipeline delivery snapshot definitions may be found here https://github.com/astroconda/astroconda-releases/tree/master/caldp
+