aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthijs van der Wild <matthijs.van-der-wild@durham.ac.uk>2025-07-09 15:06:11 -0400
committerMatthijs van der Wild <matthijs.van-der-wild@durham.ac.uk>2025-07-09 15:06:11 -0400
commit65ed21e4850196a2e1b27254122e1e2df816e262 (patch)
tree8a7eaace0c4aa290df0baa6bae9c2b3fa88639d7
parente4640d7d2803b872babfa239c49afb5978b6686c (diff)
Add Makefile
Using the script is a bit simpler if it is added to a location in the user's PATH with execution permission set. The Makefile will, in addition, remove the file extension. After running make it is a simple matter of using `pilot` on the command line.
-rw-r--r--Makefile11
-rw-r--r--README.md18
2 files changed, 26 insertions, 3 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..684c2f5
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,11 @@
+DESTDIR ?= /usr
+BINDIR ?= /bin
+
+.PHONY: install uninstall
+
+install:
+ install -v -d "$(DESTDIR)$(BINDIR)/"
+ install -m 0755 -v pilot.sh "$(DESTDIR)$(BINDIR)/pilot"
+
+uninstall:
+ rm -vrf "$(DESTDIR)$(BINDIR)/pilot"
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: