Skip to content

Commit 806c1d0

Browse files
authored
Add install instructions
Closes 153
1 parent b068284 commit 806c1d0

File tree

1 file changed

+4
-16
lines changed

1 file changed

+4
-16
lines changed

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ You may obtain a copy of the License [here](http://www.apache.org/licenses/LICEN
1818
Gas is still in alpha and accepting feedback from early adopters. We do
1919
not consider it production ready at this time.
2020

21+
### Install
22+
23+
`$ go get github.com/GoASTScanner/gas/cmd/gas/...`
24+
2125
### Usage
2226

2327
Gas can be configured to only run a subset of rules, to exclude certain file
@@ -109,19 +113,3 @@ file. The output format is controlled by the '-fmt' flag, and the output file is
109113
$ gas -fmt=json -out=results.json *.go
110114
```
111115

112-
### Docker container
113-
114-
A Dockerfile is included with the Gas source code to provide a container that
115-
allows users to easily run Gas on their code. It builds Gas, then runs it on
116-
all Go files in your current directory. Use the following commands to build
117-
and run locally:
118-
119-
To build: (run command in cloned Gas source code directory)
120-
docker build --build-arg http_proxy --build-arg https_proxy
121-
--build-arg no_proxy -t goastscanner/gas:latest .
122-
123-
To run: (run command in desired directory with Go files)
124-
docker run -v $PWD:$PWD --workdir $PWD goastscanner/gas:latest
125-
126-
Note: Docker version 17.05 or later is required (to permit multistage build).
127-
```

0 commit comments

Comments
 (0)