Skip to content

Commit 9506ecc

Browse files
committed
updated container docs
1 parent 2ba723b commit 9506ecc

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

containers/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Docker Containers
2+
3+
This directory contains one subfolder for every Docker container used in the pipeline. Each container packages the entire system environment necessary for running that step of the pipeline, making the pipeline trivially portable across sytems.
4+
5+
To easily rebuild these containers, install Docker and [maru](https://github.com/JaneliaSciComp/maru) and run `maru build`.
6+
7+
See the [Development docs](../docs/Development.md) for more information.

docs/Development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Commit as normal, then back at the root update the submodule commit pointer and
1818

1919
### Building containers
2020

21-
All containers used by the pipeline have been made available on Docker Hub. You can rebuild these to make customizations or to replace the algorithms used. To build the containers and push to Docker Hub you can use [maru](https://github.com/JaneliaSciComp/maru), or manually:
21+
All containers used by the pipeline have been made available on Docker Hub. You can rebuild these to make customizations or to replace the algorithms used. To build the containers and push to Docker Hub you can install [maru](https://github.com/JaneliaSciComp/maru) and run `maru build`, or invoke Docker manually:
2222

2323
#### Stitching container
2424
Container used for Spark-based stitching.

0 commit comments

Comments
 (0)