docs: describe build process (#109)

* docs: describe release process * docs: describe build process * docs: typo Co-authored-by: Gareth Jones <[email protected]> Co-authored-by: Gareth Jones <[email protected]> Co-authored-by: Rex P <[email protected]>
google · Jan 9, 2023 · ef29ce4 · ef29ce4
1 parent f84eb6c
commit ef29ce4
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -61,6 +61,19 @@ go install github.com/google/osv-scanner/cmd/osv-scanner@v1
 
 This requires Go 1.18+ to be installed.
 
+### Building
+
+You can build from source using [GoReleaser](https://goreleaser.com/) and running:
+
+```bash
+$ goreleaser build --rm-dist --single-target --snapshot
+```
+
+See GoReleaser [documentation](https://goreleaser.com/cmd/goreleaser_build/) for build options.
+
+You can also reproduce the downloadable builds by checking out the specific tag and running `goreleaser build`,
+using the same Go version as the one used during the actual release (see goreleaser workflows).
+
 ### SemVer Adherence
 
 All releases on the same Major version will be guaranteed to have backward compatible JSON output and CLI arguments.