From ecc9bbe4b6140c9fe0f78f6522bc88ae27d8ea1f Mon Sep 17 00:00:00 2001
From: Dana Robinson <43805+derobins@users.noreply.github.com>
Date: Wed, 17 Aug 2022 09:34:45 -0700
Subject: Adds a README.md file to bin that indicates script usage (#2024)

* Adds a README.md file to bin that indicates script usage

* Forgot header row
---
 bin/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 bin/README.md

diff --git a/bin/README.md b/bin/README.md
new file mode 100644
index 0000000..e9a4456
--- /dev/null
+++ b/bin/README.md
@@ -0,0 +1,27 @@
+#Scripts in `bin` and their purpose
+
+Programs run via `autogen.sh` (or the equivalent in CMake) are indicated.
+
+|Program|Purpose|
+|-------|-------|
+|`buildhdf5`|Convenience script to build HDF5 using the Autotools|
+|`checkapi`|Checks if public API calls are used in internal functions|
+|`checkposix`|Checks if C/POSIX calls are prefixed with `HD`|
+|`chkcopyright`|Checks if files have appropriate copyright statements|
+|`cmakehdf5`|Convenience script to build HDF5 using CMake|
+|`debug-ohdr`|Examines debug output from `H5O_open/close` to look for open objects|
+|`deploy`|Deploys HDF5 to a location in the file system|
+|`format_source`|Runs `clang-format` over the source files, applying our rules|
+|`genparser`|Creates the flex/bison-based parser files in the high-level library|
+|`h5cc.in`|Input file from which h5cc is created|
+|`h5redeploy.in`|Input file from which h5redeploy is created|
+|`h5vers`|Updates the library version number|
+|`make_err`|Generates the H5E header files (called in `autogen.sh`)|
+|`make_vers`|Generates H5version.h (called in `autogen.sh`)|
+|`make_overflow`|Generates H5overflow.h (called in `autogen.sh`)|
+|`output_filter`|Used in the tools test code to strip extraneous output before we diff files|
+|`restore.sh`|Removes files generated by `autogen.sh`|
+|`runbkprog`|Used by CMake to run test programs in the background|
+|`switch_maint_mode`|Switches maintainer mode on/off in `configure.ac`|
+|`trace`|Adds `TRACE` macros to HDF5 C library source files (run by `autogen.sh`)|
+|`warnhist`|Generates compiler warning statistics for gcc/clang when fed output of make|
-- 
cgit v0.12