diff --git a/README b/README deleted file mode 100644 index 66727b75c412d366b6a6584d82f1e455759c5001..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,64 +0,0 @@ -README - - naked-singularity - -DESCRIPTION - - A repository of definition for building Singularity* containers - around the software applications, frameworks, and libraries you need - to run on high-performance computing systems. - - * https://sylabs.io/guides/latest/user-guide - -USAGE - - 1. Install Singularity on your Linux desktop, laptop, or virtual - machine. - - ./naked-singularity.sh install - - 2. Build a simple base Ubuntu Singularity container. - - sudo singularity build ubuntu.sif definition-files/ubuntu/Singularity.ubuntu-18.04 - - A number of pre-built containers from this repository are also - now hosted at both Singularity Hub - - singularity pull shub://mkandes/naked-singularity:ubuntu-18.04 - - and Sylabs' Container Library - - singularity pull library://mkandes/naked-singularity:ubuntu-18.04 - - 3. Uninstall Singularity from your Linux desktop, laptop, or - virtual machine. - - ./naked-singularity.sh uninstall - -STATUS - - This repository is currently undergoing a major restructuring. - Significant changes over the next few weeks should be expected. - -CONTRIBUTE - - If you would like to contribute one of your own Singularity - container definition files for a specific application OR request - a modification to an existing container definition, then please - submit a pull request. - -AUTHOR - - Marty Kandes, Ph.D. - Computational & Data Science Research Specialist - High-Performance Computing User Services Group - San Diego Supercomputer Center - University of California, San Diego - -VERSION - - 1.0.1 - -LAST UPDATED - - Saturday, December 26th, 2020 diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..85399127b2ec167810d29633070c6af7680463e4 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# naked-singularity + +A repository of definition for building +[Singularity](https://sylabs.io/guides/latest/user-guide) containers +around the software applications, frameworks, and libraries you need to +run on high-performance computing systems. + +## Install Singularity + +Install Singularity on your Linux desktop, laptop, or virtual machine. + +```bash +./naked-singularity.sh install +``` + +## Build a Singularity container from a definition file + +Build an Ubuntu Singularity container from one of the definition files +available in this repository. + +```bash +sudo singularity build ubuntu.sif definition-files/ubuntu/Singularity.ubuntu-18.04 +``` + +## Download an existing Singularity container + +A number of pre-built containers from this repository are also now +hosted at Singularity Hub. + +```bash +singularity pull shub://mkandes/naked-singularity:ubuntu-18.04 +``` + +## Status + +The naked-singularity project is currently undergoing a major +restructuring of the repository. Significant changes over the next few +weeks should be expected. + +## Contribute + +If you would like to contribute one of your own Singularity container +definition files for a specific application OR request a modification to +an existing container definition, then please submit a pull request. + +## Author + +Marty Kandes, Ph.D. +Computational & Data Science Research Specialist +High-Performance Computing User Services Group +San Diego Supercomputer Center +University of California, San Diego + +## Version + +1.1.0 + +## Last Updated + +Sunday, December 27th, 2020