From 340a072bbbbab62397c3175e41f56857ddc98400 Mon Sep 17 00:00:00 2001 From: sahejsingh <31713463+sahejsingh@users.noreply.github.com> Date: Tue, 20 Feb 2018 17:11:49 +1100 Subject: [PATCH] Docker docs (#95) * Add note about docker usage --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 573c686e7..ab4cd2e90 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,23 @@ Now you can execute Sysl on the command line with :: See ``sysl --help`` and ``reljam --help`` for more options. +Docker Users can pull the docker image :: + + > docker pull anzbank/sysl:vX.Y.Z + +Consider tagging docker image to make commands shorter :: + + > docker tag anzbank/sysl:vX.Y.Z sysl + +Note the image tag in ``anzbank/sysl:vX.Y.Z``. +Replace the tag with the latest tag from `https://hub.docker.com/r/anzbank/sysl/tags/`. + +Try the following commands :: + + > docker run sysl + > docker run sysl sysl -h + > docker run sysl reljam -h + Development ----------- Install dependencies and the ``sysl`` package with symlinks ::