Skip to content

Commit 78d5c30

Browse files
update readme instructions for building from source to specify the correct version (#488)
1 parent 35d17d9 commit 78d5c30

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,31 +25,28 @@ Replace `/path/to/your/config.ini` with the path to your configuration file on t
2525

2626
### Building from Source
2727

28-
For Go 1.17 and later you must build from source:
28+
ZGrab2 requires Go 1.23 or later to build from source.
2929

3030
```shell
3131
git clone https://github.com/zmap/zgrab2.git
3232
cd zgrab2
3333
make
34-
./zgrab2
34+
./zgrab2 http --help # to see the http module's help message
3535
```
3636

37+
Starting in Go 1.21, Go added [support](https://go.dev/doc/toolchain) for auto-downloading the appropriate toolchain for building a given module.
3738

38-
For Go 1.16 and below you can install via go get:
39-
40-
You will need to have a valid `$GOPATH` set up, for more information about `$GOPATH`, see https://golang.org/doc/code.html.
41-
42-
Once you have a working `$GOPATH`, run:
39+
This will let you build ZGrab2 using Go 1.21.X or 1.22.X without needing to manually install another version.
4340

4441
```shell
45-
go get github.com/zmap/zgrab2
46-
```
47-
48-
This will install zgrab under `$GOPATH/src/github.com/zmap/zgrab2`
42+
go version
43+
$ go version go1.21.13 linux/arm64
4944

50-
```shell
51-
cd $GOPATH/src/github.com/zmap/zgrab2
52-
make
45+
export GOTOOLCHAIN=auto
46+
git clone https://github.com/zmap/zgrab2.git
47+
cd zgrab2
48+
make # Go will download the required 1.23 toolchain automatically
49+
./zgrab2 http --help # to see the http module's help message
5350
```
5451

5552
## Single Module Usage

0 commit comments

Comments
 (0)