Document all scripts in util/

util/README.md

@@ -5,12 +5,49 @@ or in releasing a new version of Hush.
 
 Utilities in this directory:
 
+## build.sh
+
+Compile Hush full node code.
+
+## build-arm.sh
+
+Compile Hush full node code for ARM architecture.
+
+## build-debian-package.sh
+
+Builds an x86 Debain package for Hush.
+
+## build-debian-package-ARM.sh
+
+Builds an ARM Debain package for Hush.
+
+## build-mac.sh
+
+Compile Hush full node code for mac. NOTE: This is likely broken.
+
+## build-win.sh
+
+Compile Hush full node code for windows
+
 ## checkpoints.pl
 
 Generate checkpoint data for chainparams.cpp . This automates the creation of
 block heights and block hashes by asking hushd for the data and then generating
 the C++ code needed to embed them in the Hush source code.
 
+## docker-entrypoint.sh
+
+Script to use Hush with Docker.
+
+## docker-hush-cli.sh
+
+Convenience script to run hush-cli in a running Docker container.
+
+## replace.pl
+
+Replace a string in a set of files by another string. Very useful for updating
+a variable name or value across many files, or updating copyrights.
+
 ## security-check.py
 
 Perform basic ELF security checks on a series of executables.
@@ -38,3 +75,7 @@ If there are 'unsupported' symbols, the return value will be 1 a list like this
 
 A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option.
 This requires help2man which can be found at: https://www.gnu.org/software/help2man/
+
+## gen-linux-binary-release.sh
+
+Generate linux release binary.