search

ContextLab / CDL-docker-stacks

Lightweight, customizable, hierarchically built docker images for common neuro/data science applications. Pre-built images available on Docker Hub
https://hub.docker.com/u/contextlab
3 stars 12 forks source link

clean up READMEs #2

Open paxtonfitzpatrick opened 3 years ago

paxtonfitzpatrick commented 3 years ago

each image directory should have a clear, concise README -- best current example is the cdl-jupyter README (sans horrible typos).

Each README will automatically be posted with respective image on Docker Hub by GitHub action (WIP) and should have at minimum 4 parts:

  1. Name (\<h1>) + brief description
  2. Quick usage commands for (at minimum) 3 use cases:
    1. running container directly from pre-built Docker Hub image
    2. build local copy of image from Dockerfile in GitHub repo
    3. Using a (tagged version of) the pre-built image on Docker Hub as a base for a new image (FROM contextlab/...[:tag])
  3. build-args available when running docker build in use case ii
  4. list of pre-installed apt, conda, and pip packages for the given image not present in the parent image, plus a link to the parent image's README.
jeremymanning commented 3 years ago

relatedly, it'd be great to have the main readme file point to build instructions, and perhaps provide a quick orientation to the different "stacks" and how to build on them