docs: update docs with new docker specific instructions (#1941)

* docs: update docs with new docker specific instructions
---------

Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
Former-commit-id: c67c76e84df84e3e24aa307637d884ca8b7e3eea
This commit is contained in:
Christopher Angelo Phillips 2023-07-17 14:19:21 -04:00 committed by GitHub
parent 35699f6fdc
commit 204b790012
3 changed files with 22 additions and 1 deletions

View File

@ -7,6 +7,25 @@ In order to test and develop in this repo you will need the following dependenci
- docker
- make
### Docker settings for getting started
Make sure you've updated your docker settings so the default docker socket path is available.
Go to:
docker -> settings -> advanced
Make sure:
```
Allow the default Docker socket to be used
```
is checked.
Also double check that the docker context being used is the default context. If it is not, run:
`docker context use default`
After cloning the following step can help you get setup:
1. run `make bootstrap` to download go mod dependencies, create the `/.tmp` dir, and download helper utilities.
2. run `make` to view the selection of developer commands in the Makefile

View File

@ -313,7 +313,8 @@ generate-license-list: ## Generate an updated spdx license list
## Build-related targets #################################
.PHONY: build
build: $(SNAPSHOT_DIR) ## Build release snapshot binaries and packages
build:
CGO_ENABLED=0 go build -trimpath -ldflags "$(LDFLAGS)" -o $@ ./cmd/syft
$(SNAPSHOT_DIR): ## Build snapshot release binaries and packages
$(call title,Building snapshot artifacts)

1
build.REMOVED.git-id Normal file
View File

@ -0,0 +1 @@
ab24f7f8cbf320cf498fcf0ca9b926ed93d4475a