diff --git a/README.md b/README.md index 001a88af..c1869dc7 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,20 @@ using tools and libraries such as: * runC * Singularity +## Advantages +* Provides a docker like command line interface +* Supports a subset of docker commands: + search, pull, import, export, load, create and run +* Understands docker container metadata +* Can be deployed by the end-user +* Does not require privileges for installation +* Does not require privileges for execution +* Does not require compilation, just transfer the Python script and run +* Encapsulates several execution methods +* Includes the required tools already compiled to work across systems +* Tested with GPGPU and MPI applications +* Runs both on new and older Linux distributions (including: CentOS 6, CentOS 7, Ubuntu 14, Ubuntu 16, Fedora, etc) + ## Installation See the [Installation manual](doc/installation_manual.md) diff --git a/doc/installation_manual.md b/doc/installation_manual.md index 3d9c211c..c0dacaea 100644 --- a/doc/installation_manual.md +++ b/doc/installation_manual.md @@ -59,7 +59,7 @@ From the master branch: ``` curl https://raw.githubusercontent.com/indigo-dc/udocker/master/udocker.py > udocker chmod u+rx ./udocker - ./udocker version + ./udocker install ``` From the development branch: @@ -67,7 +67,7 @@ From the development branch: ``` curl https://raw.githubusercontent.com/indigo-dc/udocker/devel/udocker.py > udocker chmod u+rx ./udocker - ./udocker version + ./udocker install ``` ### 2.3. OBTAINING THE URL OF THE LATEST TARBALL @@ -78,9 +78,6 @@ installation tarball URL by invoking the `version` command. The tarball location contain several URLs pointing to mirrors. ``` - git clone https://github.com/indigo-dc/udocker - cd udocker - chmod u+rx udocker ./udocker version ``` @@ -88,7 +85,7 @@ Third, pick one URL and download the tarball using tools such as curl or wget. ### 2.4. FORCE INSTALLATION -To force reinstallation invoke udocker install with the flag `--force`: +To force download and reinstallation of the udocker tools. Invoke udocker install with the flag `--force`: ``` ./udocker install --force @@ -174,6 +171,7 @@ To get the udocker source code repository from the devel branch. ``` git clone https://github.com/indigo-dc/udocker + cd udocker checkout devel ```