From cab040caa95fea88bc263407cbe4b88796a66e83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raik=20Gr=C3=BCnberg?= Date: Sat, 4 Aug 2018 19:11:05 +0300 Subject: [PATCH] update Readme --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3f7c8a8..6b41936 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # biskitbase -A Docker container with all biskit library requirements as well as third-party programs wrapped by biskit. +A Docker container with all biskit library requirements as well as third-party programs wrapped by biskit (but not biskit itself). This container is the base layer used by the full biskit docker image graik/biskit. It contains all the dependencies for biskit and many of the third-party programs for which there exist biskit wrappers. It **does not** contain biskit itself. @@ -8,9 +8,20 @@ The project contains an empty folder `downloads`. The docker script will look in Note: this container is optimized for running the Python 3.x version of Biskit (branch `biskit3` in the github project). -To build run: +__Setup__ -``` +To re-build it locally run (change the `graik/biskitbase` tag as appropriate): +```sh +git clone https://github.com/graik/biskitbase.git +cd biskitbase docker build -t graik/biskitbase . ``` - +Then run the image interactively with: +```sh +docker run -it graik/biskitbase bash +``` +Publish it to dockerstore with: +```sh +docker login +docker push graik/biskitbase +```