From ddd47d0138f0d17694c3c0fa89b6c01a1deaa8af Mon Sep 17 00:00:00 2001
From: Mike Lake <Mike.Lake@uts.edu.au>
Date: Tue, 26 Oct 2021 13:03:50 +1100
Subject: [PATCH] Minor changes

---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index eb22f63..70afa41 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# hpc_utilisation
+# HPC Utilisation Script
 
-Python program to check the utilisation of HPC jobs using the PBS schedular.
+Python program to check the utilisation of HPC jobs using the PBS scheduler.
 
 ## Usage
 
@@ -10,6 +10,8 @@ If you run the program with no args you will get brief usage information:
     usage: check_utilisation.py  running|finished|all  [-h] [-u USER] [-e EMAIL]
     check_utilisation.py: error: the following arguments are required: state
 
+Running with the `-h` option will give more detailed help: `$ ./check_utilisation.py -h` 
+
 You need to specify a "job state" to query; either "running", "finished" or "all" 
 like this:
 
@@ -33,7 +35,10 @@ like this:
     To rerun this, and email this report to yourself, run this command:
       ./check_utilisation.py running -e your_email
 
+This will also have written a HTML page with the above information. You can email yourself 
+a HTML formatted emailo with this information by using the `-e` option.
 
+Running with the `-u` option will limit results to a specific user. 
 
 ## Files
 
@@ -84,6 +89,9 @@ The above script runs `swig` which uses the SWIG interface file `pbs.i` to
 create `pbs.py` and `pbs_wrap.c`. Then it uses `gcc` to compile `pbs_wrap.c` 
 to create `_pbs.so`. The swig generated `pbs.py` imports `_pbs.so` at run time.
 
+Now edit `check_utilisation.py` and fill in the required parameters for your site 
+i.e. the `from_email` and the `mail_server` settings.
+
 Now you should be able to run the utilisation script:
 
     $ ./check_utilisation.py -h
-- 
GitLab