improve documentation regarding external dependencies #330
Conversation
There was a problem hiding this comment.
@CaptTofu, Thanks for updating our documentation!
I tested this by making a new VM and running all the commands the old way (which didn't work) then I did it your way (which worked). Seems to work. Thanks!
PS: Have you signed the Google CLA?
README.md
Outdated
|
|
||
| ```sh | ||
| go get -u github.com/golang/protobuf/protoc-gen-go | ||
| go get google.golang.org/grpc |
There was a problem hiding this comment.
Can you add a -u to this call to go get
README.md
Outdated
| go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway | ||
| go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger | ||
| go get -u github.com/golang/protobuf/protoc-gen-go | ||
| go get -u golang.org/x/net/context` |
There was a problem hiding this comment.
I think there is a stray ` at the end of this line
README.md
Outdated
| @@ -89,7 +91,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`. | |||
| ```sh | |||
| protoc -I/usr/local/include -I. \ | |||
| -I$GOPATH/src \ | |||
| -I$GOPATH/src/github.com/googleapis/googleapis/ \ | |||
| -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis | |||
There was a problem hiding this comment.
Can you add a trailing \ on this line?
|
Made changes. Also, I am under HPE's Google Corporate CLA |
README.md
Outdated
|
|
||
| ```sh | ||
| go get -u github.com/golang/protobuf/protoc-gen-go |
There was a problem hiding this comment.
Why are these additions necessary?
There was a problem hiding this comment.
I accept the first one, for the others added (grpc,context) I would prefer to tell users to 'go get .' after generating code.
There was a problem hiding this comment.
The reason I chose explicit packages is I kept adding whatever the results of "go build" would complain about such as in "cannot find package "google.golang.org/grpc"
I didn't know about "go get .". I'll just simply use that as I tested that it works.
b9d0e3a to
568f1fc
Compare
|
Hi there - I think I made all the changes that were requested. Also, I'm covered under the CLA - not sure why that is giving a "status to be reported" |
|
I signed it! |
I had some problems on OS X that I was chasing my tail with. I realize now what I was doing wrong and updated the docs to reflect an incorrect include path as well as missing golang packages.
many thanks to Travis Cline for the help!