rabbah commented on a change in pull request #143: URL: https://github.com/apache/openwhisk-client-go/pull/143#discussion_r581346349
########## File path: README.md ########## @@ -21,39 +21,76 @@ [](http://www.apache.org/licenses/LICENSE-2.0) [](https://travis-ci.com/apache/openwhisk-client-go) -This project `openwhisk-client-go` is a Go client library to access Openwhisk API. +This project `openwhisk-client-go` is a Go client library to access the Openwhisk API. +--- + +## Building the project ### Prerequisites -You need to install the following package in order to run this Go client library: -- [Go](https://golang.org/doc/install) -- [govendor](https://github.com/kardianos/govendor) +The Openwhisk Go Client library requires you to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended Make sure you select the package that fits your local environment, and [set the GOPATH environment variable](https://github.com/golang/go/wiki/SettingGOPATH). +### GoLang setup + +The wskdeploy utility is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine. Review comment: why is this mentioned here? ########## File path: README.md ########## @@ -21,39 +21,76 @@ [](http://www.apache.org/licenses/LICENSE-2.0) [](https://travis-ci.com/apache/openwhisk-client-go) -This project `openwhisk-client-go` is a Go client library to access Openwhisk API. +This project `openwhisk-client-go` is a Go client library to access the Openwhisk API. +--- + +## Building the project ### Prerequisites -You need to install the following package in order to run this Go client library: -- [Go](https://golang.org/doc/install) -- [govendor](https://github.com/kardianos/govendor) +The Openwhisk Go Client library requires you to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended Make sure you select the package that fits your local environment, and [set the GOPATH environment variable](https://github.com/golang/go/wiki/SettingGOPATH). +### GoLang setup + +The wskdeploy utility is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended + +Make sure your `$GOPATH` is defined correctly in your environment. For detailed setup of your GoLang development environment, please read [How to Write Go Code](https://golang.org/doc/code.html). + +### Download the source code from GitHub + +As the code is managed using GitHub, it is easiest to retrieve the code using the `git clone` command. + +if you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository: + +```sh +git clone [email protected]:apache/openwhisk-client-go +``` + +or you can specify a release (tag) if you do not want the latest code by using the `--branch <tag>` flag. For example, you can clone the source code for the tagged 1.1.0 [release](https://github.com/apache/openwhisk-client-go/releases) Review comment: ```suggestion You can also specify a release (tag) if you do not want the latest code by using the `--branch <tag>` flag. For example, you can clone the source code for the tagged 1.1.0 [release](https://github.com/apache/openwhisk-client-go/releases) ``` ########## File path: README.md ########## @@ -21,39 +21,76 @@ [](http://www.apache.org/licenses/LICENSE-2.0) [](https://travis-ci.com/apache/openwhisk-client-go) -This project `openwhisk-client-go` is a Go client library to access Openwhisk API. +This project `openwhisk-client-go` is a Go client library to access the Openwhisk API. +--- + +## Building the project ### Prerequisites -You need to install the following package in order to run this Go client library: -- [Go](https://golang.org/doc/install) -- [govendor](https://github.com/kardianos/govendor) +The Openwhisk Go Client library requires you to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended Make sure you select the package that fits your local environment, and [set the GOPATH environment variable](https://github.com/golang/go/wiki/SettingGOPATH). +### GoLang setup + +The wskdeploy utility is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine. + +> **Note** Go version 1.15 or higher is recommended + +Make sure your `$GOPATH` is defined correctly in your environment. For detailed setup of your GoLang development environment, please read [How to Write Go Code](https://golang.org/doc/code.html). + +### Download the source code from GitHub + +As the code is managed using GitHub, it is easiest to retrieve the code using the `git clone` command. + +if you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository: Review comment: ```suggestion If you just want to build the code and do not intend to be a Contributor, you can clone the latest code from the Apache repository: ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
