tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(hooks/formatHeader): updated readme

Browse Source
This commit is contained in:
Emily Boudreaux
2025-03-17 12:44:55 -04:00
parent 8fb63bf691
commit a2268c0b54
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
commit-config/hooks/READEME.md
View File

@@ -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.