diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9fc2df4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,23 @@ +# NCO ecFlow Scripts and Utilities + +Scripts and utilities for interacting with ecFlow servers and +managing production jobs. + +## NCO Maintained Directories + +The directories below are maintained by the NCO SPA team. These +directories and their contents are version controlled in this +GitHub repo. + +- `include/` +- `scripts/` +- `versions/` + +## ecFlow Package Directories + +The directories below are populated by building ecFlow from source. +These directories *are not* version controlled in this GitHub repo. + +`bin/` +`lib/` +`share/ecflow/etc/`