From 60ad573b87e5b1491dabc6cc01ca33790d0f97c2 Mon Sep 17 00:00:00 2001 From: Jared Custer Date: Wed, 19 Oct 2022 11:59:34 -0600 Subject: [PATCH] Create README.md --- src/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 src/README.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..d9bebdf --- /dev/null +++ b/src/README.md @@ -0,0 +1,12 @@ +# safeguard-bash Developer Guide +Bash script development can be done many ways, this is just one way in a linux terminal. + +### Requirements +* Install [jq](https://stedolan.github.io/jq/manual/), this is not mandatory, but it is not installed by default and the user experience is better if installed. + +* Clone this repository + +### Installation +After cloning this repository, run the `install-local.sh` script. This will copy the relevant scripts to `$HOME/scripts`, +and add that directory to your `$PATH` environment variable. After editing any of the scripts in the src directory simply +run `install-local.sh` and test your changes.