Added additonal information for installation and usage to make setup … #347
Conversation
|
Since 1.8, GOPATH env var is not required. golang/go#17262 . A backward compatible alternative is |
| @@ -35,6 +36,8 @@ make | |||
| make check | |||
| sudo make install | |||
| ``` | |||
| If you are using cygwin and ProtocolBuffers 3.0.0-beta-3 or later is not available for cygwin yet install the Windows version. | |||
There was a problem hiding this comment.
would it be appropriate to place windows instructions in its own section?
| @@ -128,7 +136,7 @@ Make sure that your `$GOPATH/bin` is in your `$PATH`. | |||
|
|
|||
| It will generate a reverse proxy `path/to/your_service.pb.gw.go`. | |||
|
|
|||
| Note: After generating the code for each of the stubs, in order to build the code, you will want to run ```go get .``` from the directory containing the stubs. | |||
| Note: After generating the code for each of the stubs, in order to build the code, you will want to move the stubs into your `$GOPATH/src` working directory and run ```go get .``` from the directory containing the stubs. | |||
There was a problem hiding this comment.
how about we recommend that folks work inside of GOPATH over moving files after gen?
There was a problem hiding this comment.
the protoc command creates the stubs in the same directory as the service.proto file. is it possible to provide an output directory for the protoc plugins?
|
|
||
| Run this inside the directory containg your `main.go`. | ||
| ``` | ||
| go build |
There was a problem hiding this comment.
let's recommend go install instead
|
@mrt181 still need a CLA sign here |
|
Already done? |
|
@mrt181 thanks! there are a few outstanding comments/suggestions. |
|
I would suggest to reject this PR. |
|
@mrt181 thanks for the great documentation contribution! |
…easier. #346