From a2268c0b54e9a890d244c52c1a0fe1f92a32816f Mon Sep 17 00:00:00 2001 From: Emily Boudreaux Date: Mon, 17 Mar 2025 12:44:55 -0400 Subject: [PATCH] docs(hooks/formatHeader): updated readme --- commit-config/hooks/READEME.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/commit-config/hooks/READEME.md b/commit-config/hooks/READEME.md index 7eca776..cac0612 100644 --- a/commit-config/hooks/READEME.md +++ b/commit-config/hooks/READEME.md @@ -40,3 +40,9 @@ This will automatically add the following (or similar...) header to the file // // *********************************************************************** */ ``` + +The project name may be changed with the `--project` command line argument. `--project` defaults to "4DSSE" + +## Notes +- Generally this script is **not** meant to be directly invoked. Rather, it is meant to be run as a pre-commit-hook automatically. +- There are defaults for root and project; however, they can be configured with command line options so if they change with time those changes can be easily propegated to this script.