github.com/apptainer/singularity@v3.1.1+incompatible/examples/README.md (about)

     1  # Examples
     2  The example bootstrap definition files, each called `Singularity`, are 
     3  located in their respectively named folders in this directory. 
     4  These files can be used to create new container images on a variety of 
     5  Linux distributions or become the basis for customization to 
     6  build reproducible containers for a specific purpose. While many of these
     7  examples use core mirrors and OS distributions, keep in mind that you can
     8  use a Docker bootstrap to create almost any of them.
     9  
    10  ## Contributing
    11  If you have a specific scientific (or other) container, we suggest that you
    12  consider [singularity hub](https://singularity-hub.org) to serve it. If you do
    13  not intend to build or use the container, or want to provide a base template, 
    14  then you might also want to send a pull request to add it here.
    15  
    16  ### contrib
    17  If you wish to contribute a definition file that does not fall within one
    18  of the folders here, it should go into [contrib](contrib). In this case,
    19  please send a pull request and contribute it to the examples/contribs 
    20  directory with the format being hyphen ('-') delimited of the following format:
    21  
    22      1. Base distribution name and version if applicable (e.g. centos7 or
    23          ubuntu_trusty)
    24      2. Target nomenclature that describes the container (e.g. tensorflow)
    25      3. Any relevant version strings to the application or work-flow
    26      4. Always end in .def
    27  
    28  An example of this:
    29  
    30      examples/contrib/debian84-tensorflow-0.10.def
    31  
    32  ### base
    33  If your contribution is more appropriate for one of the base or template distributions,
    34  then please make a respective folder in the [examples](.) directory, and name
    35  the definition file `Singularity`.