Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1023

Merged
merged 3 commits into from
Jan 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions protobuf/protoc-gen-go-grain/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
If you are using `protoc`, you need to ensure the required dependencies are available to the compiler at compile time. These can be found by manually cloning and copying the relevant files from here and providing them to protoc when running. The files you will need are:
```
protobuf/protoc-gen-go-grain/options/options.proto
```
- Go plugins for the protocol compiler:

1. Install the protocol compiler plugins for Go using the following commands:
```
go install github.com/asynkron/protoactor-go/protobuf/protoc-gen-go-grain@latest
```

2. Update your PATH so that the protoc compiler can find the plugins:
```
export PATH="$PATH:$(go env GOPATH)/bin"
```

3. Compile `.proto` file
```
protoc --go_out=. --go_opt=paths=source_relative \
--go-grain_out=. --go-grain_opt=paths=source_relative hello.proto
```

- If you are using `protoc`, you need to ensure the required dependencies are available to the compiler at compile time. These can be found by manually cloning and copying the relevant files from here and providing them to protoc when running. The files you will need are:
```
protobuf/protoc-gen-go-grain/options/options.proto
```