From ac585418cb63b91bb59ff71f98140117abeba32a Mon Sep 17 00:00:00 2001
From: Ben Davies <ben.davies@anu.edu.au>
Date: Tue, 8 Oct 2024 16:30:13 +1100
Subject: [PATCH] Update usage docs.

---
 integration/binary_diff.sh | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/integration/binary_diff.sh b/integration/binary_diff.sh
index aab4f01..44b06eb 100755
--- a/integration/binary_diff.sh
+++ b/integration/binary_diff.sh
@@ -6,11 +6,22 @@
 # between Martix Dix's base script & changes introduced by the
 # um2nc-standalone development effort.
 #
-# NB: will display some um2nc output
+# TODO: add larger inputs with more vars to the testing?
 #
-# This script warns if there is a binary difference comparing netCDF files
 #
-# TODO: add larger inputs with more vars to the testing?
+# Terminal session setup
+# $ export UM2NC_PROJ=<um2nc-standalone git dir>
+# $ export UM2NC_TEST_DATA=<dir with test netCDFs>
+#
+# Usage:
+# cd <um2nc-standalone git dir>
+# ./integration/binary_diff.sh
+#
+# NB: will display some um2nc output
+#
+# Script warns if there is a binary difference comparing netCDF files
+# If debugging a diff, the original source netCDF & the um2nc dev netCDF
+# can be converted to text with `ncks` & compared with a diff tool.
 
 echo "Binary equivalence/backwards compatibility diff for um2nc-standalone"