Skip to content

Commit

Permalink
Updates docs regarding golang usage and deps
Browse files Browse the repository at this point in the history
Signed-off-by: Sotiris Nanopoulos <sonanopo@microsoft.com>
  • Loading branch information
Sotiris Nanopoulos committed May 10, 2021
1 parent 0fc8772 commit 683ce08
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ check-go-version: # Ensure the Go version used is what OSM requires
@if [ $(GO_VERSION_MAJOR) -gt $(MIN_REQUIRED_GO_VERSION_MAJOR) ]; then \
exit 0 ;\
elif [ $(GO_VERSION_MAJOR) -lt $(MIN_REQUIRED_GO_VERSION_MAJOR) ]; then \
@echo -e '$(GO_VERSION_MESSAGE)';\
echo -e '$(GO_VERSION_MESSAGE)';\
exit 1; \
elif [ $(GO_VERSION_MINOR) -gt $(MIN_REQUIRED_GO_VERSION_MINOR) ] ; then \
exit 0; \
elif [ $(GO_VERSION_MINOR) -lt $(MIN_REQUIRED_GO_VERSION_MINOR) ] ; then \
@echo -e '$(GO_VERSION_MESSAGE)';\
echo -e '$(GO_VERSION_MESSAGE)';\
exit 1; \
elif [ $(GO_VERSION_PATCH) -lt $(MIN_REQUIRED_GO_VERSION_PATCH) ] ; then \
@echo -e '$(GO_VERSION_MESSAGE)';\
echo -e '$(GO_VERSION_MESSAGE)';\
exit 1; \
fi

Expand Down
4 changes: 3 additions & 1 deletion docs/content/docs/dev_guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ OSM leverages [Envoy proxy](https://github.com/envoyproxy/envoy) as a data plane

## Get Go-ing

This Open Service Mesh project uses [Go v1.15](https://golang.org/). If you are not familiar with Go, spend some time with the excellent [Tour of Go](https://tour.golang.org/).
This Open Service Mesh project uses [Go v1.15.7+](https://golang.org/). If you are not familiar with Go, spend some time with the excellent [Tour of Go](https://tour.golang.org/).

## Get the dependencies

Expand All @@ -80,6 +80,8 @@ Take a peek at the `go.mod` file in the root of this repository to see all depen

Run `go get -d ./...` to download all required Go packages.

Also the project requires Docker. See how to install Docker [here].(https://docs.docker.com/engine/install/)

#### Makefile

Many of the operations within the OSM repo have GNU Makefile targets.
Expand Down

0 comments on commit 683ce08

Please sign in to comment.