From 37fc8a74dff24315560a6f14e0332c555abc6517 Mon Sep 17 00:00:00 2001 From: David Janowski Date: Tue, 20 Feb 2024 10:59:34 +0100 Subject: [PATCH] doc: updated readme to include all steps --- build/package/README.md | 4 ++-- scripts/README.md | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/build/package/README.md b/build/package/README.md index 0481767..0188b44 100644 --- a/build/package/README.md +++ b/build/package/README.md @@ -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: diff --git a/scripts/README.md b/scripts/README.md index 93a5346..c615f7c 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -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