Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JaredCuster authored Oct 19, 2022
1 parent 9507159 commit 60ad573
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 60ad573

Please sign in to comment.