doc: updated readme to include all steps
This commit is contained in:
parent
f5f4855d5b
commit
37fc8a74df
@ -1,8 +1,8 @@
|
|||||||
# Building a Plug
|
# Building a Plug
|
||||||
|
|
||||||
When building a Plug use the following command and replace the _test_ placeholder with the plugs name. It is also im ortend that you are in the root folder of the project.
|
When building a Plug use the following command and set the value of the ``PLUG_NAME`` with the plugs name. It is also im ortend that you are in the root folder of the project.
|
||||||
````bash
|
````bash
|
||||||
docker build --build-arg="PLUG_NAME=test" -t test -f .\build\package\Dockerfile .
|
docker build --build-arg="PLUG_NAME=" -t test -f .\build\package\Dockerfile .
|
||||||
````
|
````
|
||||||
|
|
||||||
Dockerfile:
|
Dockerfile:
|
||||||
|
@ -17,7 +17,9 @@ To generate the gRPC files you need to do the following:
|
|||||||
git submodule update
|
git submodule update
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Depending on what OS you are running execute one of the following scripts:
|
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
|
````bash
|
||||||
scripts/generate_grpc_files.sh
|
scripts/generate_grpc_files.sh
|
||||||
scripts/generate_grpc_files.ps1
|
scripts/generate_grpc_files.ps1
|
||||||
|
Reference in New Issue
Block a user