From 7279b731dec97d369f2886917ddc62d56491a933 Mon Sep 17 00:00:00 2001
From: "George.Gayno" <george.gayno@noaa.gov>
Date: Wed, 26 Apr 2023 18:58:36 +0000
Subject: [PATCH] Improve documentation per Kate's recommendation.

Fixes #818.
---
 README.md           |  8 ++++++--
 fix/link_fixdirs.sh | 10 +++++++++-
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 097c9111d..d4518238a 100644
--- a/README.md
+++ b/README.md
@@ -61,8 +61,12 @@ It also uses the following repositories:
 
 On Orion, Jet, Hera and WCOSS2 do the following:
 
-1) Set the 'fixed' directories using the 'link_fixdirs.sh'
-script in ./fix. See the script's prolog for details.
+1) Set the 'fixed' directories using the `link_fixdirs.sh`
+script in `./fix`. Usage: `./link_fixdirs.sh $RUN_ENVIR $machine`,
+where `$RUN_ENVIR` is "emc" or "nco" (most developers
+should choose "emc") and `$machine` is the platform.
+
+Example: `./link_fixdirs.sh emc hera`
 
 2) This repository uses submodules, so do:
 
diff --git a/fix/link_fixdirs.sh b/fix/link_fixdirs.sh
index 3533a78d1..7fcc370c6 100755
--- a/fix/link_fixdirs.sh
+++ b/fix/link_fixdirs.sh
@@ -1,7 +1,15 @@
 #!/bin/bash
 set -ex
 
-#--Make symbolic links to 'fixed' directories.
+# Set up the 'fixed' directories. 
+# 
+# This script takes two arguments:
+#
+#  $RUN_ENVIR - Either 'emc' (creates links) or
+#               'nco' (copies data).
+#
+#  $machine - is the machine. Choices are:
+#             'wcoss2', 'hera', 'jet', 'orion', 's4'
 
 RUN_ENVIR=${1}
 machine=${2}