This repository has been archived on 2024-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
plug-sdk/scripts/README.md

27 lines
848 B
Markdown
Raw Permalink Normal View History

2024-02-20 09:45:07 +00:00
# Generate the gRPC files
To generate the gRPC files you need to do the following:
## Prerequisites:
1. You need to install the [gRPC Compiler](https://grpc.io/docs/protoc-installation/)
2. Install the Golang Plugin for the compiler
````bash
2024-07-06 20:08:19 +00:00
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
``````
## Generate:
2024-02-20 09:45:07 +00:00
1. Download the Git submodules (if you didn't clone this repo with ``git clone --recurse-submodules``)
```bash
git submodule init
git submodule update
```
2. Edit the scripts, find the variable ``plugName`` and set its value to the name of the plug.
3. Depending on what OS you are running execute one of the following scripts:
````bash
scripts/generate_grpc_files.sh
scripts/generate_grpc_files.ps1
````