Add help about the ADR_TEMPLATE environment variable

README.md

@@ -42,12 +42,15 @@ when you initialise the ADR log.
     ADR 9, and changes the status of ADR 9 to indicate that it is
     superceded by the new ADR.  It then opens the new ADR in your
     editor of choice.
+
+3.  Configure the template.
+
+        export ADR_TEMPLATE=<path to file>
 
-3. For further information, use the built in help:
+4. For further information, use the built in help:
 
         adr help
 
-
 See the [tests](tests/) for detailed examples.
 
 The decisions for this tool are recorded as [architecture decision records in the project repository](doc/adr/). 

src/_adr_help_config

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -e
+eval "$($(dirname $0)/adr-config)"
+
+cat <<ENDHELP
+usage: adr config 
+
+Displays the current configuration.
+
+The adr_template_dir parameter defaults to the adr installation
+but can be overwriten if a custom template is required by settting the
+ADR_TEMPLATE environment variable to the custom file.
+
+    export ADR_TEMPLATE=<adr template file>
+
+ENDHELP

src/adr-config

@@ -3,5 +3,10 @@
 
 basedir=$(cd -L $(dirname $0) >/dev/null 2>&1 && pwd -L)
 
+adr_template=$basedir
+if [[ -n $ADR_TEMPLATE  ]]; then
+  adr_template=`dirname $ADR_TEMPLATE`
+fi
+
 echo 'adr_bin_dir="'"${basedir}"'"'
-echo 'adr_template_dir="'"${basedir}"'"'
+echo 'adr_template_dir="'"${adr_template}"'"'