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:59:34 +01:00
parent f5f4855d5b
commit 37fc8a74df
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
build/package/README.md
View File

@ -1,8 +1,8 @@
# 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
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:

4
scripts/README.md
View File

@ -17,7 +17,9 @@ To generate the gRPC files you need to do the following:
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
scripts/generate_grpc_files.sh
scripts/generate_grpc_files.ps1