diff --git a/README.md b/README.md index 2b8b1878a6713e4d374b06701c60ea4b136bf293..98122e09697df0ac55a3429f7c73bc06a5521653 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# Dockerfiles +# Dockerfiles for base images used in KM3NeT + +This repository contains `Dockerfiles` commonly used as base images for +KM3NeT software. + +The images are automatically built and pushed to the `docker.km3net.de` +repository under the `base` namespace, which means e.g. the image for +the `Dockerfile` `base/python:3` can used by using the URL +`docker.km3net.de/base/python:3`. + +To start up container and access a shell within, use the usual `docker` +commands like: + + docker run -it docker.km3net.de/base/centos:7 + +It is recommended to use these images in your `~/.gitlab-ci.yml` file for +continuous integrations instead of the public images from DockerHub.