diff --git a/README.md b/README.md index 70e5c4f..5b70bd2 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,29 @@ SCATR is a simple framework to test static analyzers and Autofixers. ## Getting Started +### Installation + +If you are on platforms where binaries are supported feel free to use the ones, provided in the releases. + +In case you would like to install from source, + +```sh +# make sure to install go from `go.dev` +# clone the repo +git clone https://github.com/deepsourcelabs/SCATR + +# cd into the directory +cd SCATR + +# build and install manually or use go install +go install ./cmd/scatr + +# ensure that $GOPATH is added to your paths +# the default $GOPATH=/home//go +``` + +### Usage + `scatr` accepts a `.scatr.toml` as its configuration file. ```toml