anthrove/plug-sdk
Archived
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Activity

doc: updated readme to include all steps

Browse Source
This commit is contained in:
David Janowski 2024-02-20 10:54:05 +01:00
parent 38192b321b
commit f5f4855d5b
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
scripts/README.md
View File

@ -2,8 +2,23 @@
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
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
````
## Generate:
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. Depending on what OS you are running execute one of the following scripts:
````bash
scripts/generate_grpc_files.sh
scripts/generate_grpc_files.ps1
````