aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index da099dc..70cfd44 100644
--- a/README.md
+++ b/README.md
@@ -16,11 +16,23 @@ This script assumes the following:
* `$CWL_SINGULARITY_CACHE` is set and the corresponding path contains (a link to) a singularity container `vlbi-cwl.sif`.
If it isn't set a suitable container can be specified as detailed below.
-## Execution
+## Installation
-The script can be run as follows:
+The script can be installed to `/usr/bin` via
```
-sh pilot.sh [options] <workflow name> $BINDDIR
+make install
+```
+while uninstalling the script is as straightforward as running
+```
+make uninstall
+```
+A custom installation location can be specified by setting `DESTDIR`.
+
+## Usage
+
+Once installed the script can be run as follows:
+```
+pilot [options] <workflow name> $BINDDIR
```
Options can be the following: