From d43b8e7729f979ca83620a3dc62ccad83bc907b1 Mon Sep 17 00:00:00 2001
From: gsell <achim.gsell@psi.ch>
Date: Tue, 21 Nov 2017 15:27:32 +0100
Subject: [PATCH] Update README.md

---
 Tools/HDFView/README.md | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

diff --git a/Tools/HDFView/README.md b/Tools/HDFView/README.md
index dbca2a0..8f055ce 100644
--- a/Tools/HDFView/README.md
+++ b/Tools/HDFView/README.md
@@ -2,9 +2,21 @@
 
 ## Notations
 
-`$P`: Package name here HDFView
+`$PMODULES_ROOT`: root of Pmodules environment. AT PSI this is `/opt/psi`.
 
-`$V`: Package version
+`$GRP`: group the module is installed in, here 'Tools'
+
+`$P`: package name, here HDFView.
+
+`$V`: package version.
+
+`$PREFIX`: prefix of module, this is `$PMODULES_ROOT/$GRP/$P/$V` which is at PSI `/opt/psi/Tools/HDFView/$V`.
+
+`$BUILDBLOCK_DIR`: the directory of this file.
+
+`MODULEFILES_DIR`: top-level directory where the modulefiles are installed relative to the group: `$PMODULES_ROOT/$GRP/modulefiles`.
+
+`$RELEASE`: release of module either '`unstable`', '`stable`'   or '`deprecated`'
 
 ## Download
 
@@ -13,20 +25,19 @@ Download the package from https://www.hdfgroup.org/downloads/hdfview/. The compr
 ## Install the package
 
 1. Unpack the downloaded tar-file
-1. HDFView is installed in the group 'Tools'
-2. change to the directory `/opt/psi/Tools'
+2. `cd "$PMODULES_ROOT/Tools"`.
 3. Run the installer script
 4. Accept the license
 5. Answer 'no' to the question "Do you want to include the subdirectory HDFView-$V-Linux?"
-6. HDFView will be installed with the relative path `HDFView/$V`
+6. HDFView will be installed into `$PREFIX`
 
 ## Post-install
 
-1. `cd HDFView/$V`
-1. `mkdir bin libexec`
-1. `mv hdfview.sh libexec`
-2. copy wrapper scrip `HDFView` to `bin` 
+1. `mkdir "$PREFIX"/{bin,libexec}`
+1. `mv "$PREFIX/hdfview.sh" "$PREFIX/libexec"`
+2. `install --mode 0755 "$BUILDBLOCK_DIR/HDFView" "$PREFIX/bin"` 
 
-## Install modulefile
+## Install file for Pmodules
 
-1. 
\ No newline at end of file
+1. `install --mode 0644 "$BUILDBLOCK_DIR/modulefile" "$MODULEFILES_DIR/$P/$V"`
+2. `echo "$RELEASE" > "$MODULEFILES_DIR/$P/.release-$V"
\ No newline at end of file