add: install instructions (#6)

* add: Install instructions * Update README.md Co-authored-by: Akshit Garg <[email protected]> Signed-off-by: Tushar Sadhwani <[email protected]> * fix: whitespace Signed-off-by: Tushar Sadhwani <[email protected]> --------- Signed-off-by: Tushar Sadhwani <[email protected]> Co-authored-by: Tushar Sadhwani <[email protected]> Co-authored-by: Akshit Garg <[email protected]>
DeepSourceCorp · Mar 2, 2023 · d364e0f · d364e0f
1 parent b622fdc
commit d364e0f
Showing 1 changed file with 23 additions and 0 deletions.
diff --git 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/<user>/go
+```
+
+### Usage
+
 `scatr` accepts a `.scatr.toml` as its configuration file.
 
 ```toml