diff --git a/scripts/README.md b/scripts/README.md index eabcfcf..93a5346 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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 -``` \ No newline at end of file + ```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 + ````