From 3a47cb7673c603ef074579d03284a41741060756 Mon Sep 17 00:00:00 2001 From: "aravind.est" Date: Tue, 9 Jan 2024 12:15:23 +0000 Subject: [PATCH] Add sample rApp generator README README file added for sample rApp generator. Issue-ID: NONRTRIC-964 Change-Id: I841385a1a4441c4e8b36538226cd37701805ba97 Signed-off-by: aravind.est --- sample-rapp-generator/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100755 sample-rapp-generator/README.md diff --git a/sample-rapp-generator/README.md b/sample-rapp-generator/README.md new file mode 100755 index 0000000..d437d7b --- /dev/null +++ b/sample-rapp-generator/README.md @@ -0,0 +1,26 @@ +# Sample rApp Generator +The rApp generator supports generating the rApp package from the resources. + +### Sample rApp Package Structure (**It is a prototype**) + +This is a sample structure, and rApp package contents can be placed depending on the requirements of rApp. + +![Image](../docs/images/rApp-package-1.png "Rapp package") +![Image](../docs/images/rApp-package-2.png "Rapp package") + +### Generate rApp package + +rApp package generator script takes the directory name as an argument and generates the rApp package with the contents inside the given directory. + +#### Generating in Linux environment + +> ./generate.sh rapp-all + + +#### Generating in Windows environment + +> generate.bat rapp-all + + +This should generate rApp package named after the directory with the extension of .csar(e.g., rapp-all.csar) and it is placed parallel to the script. + -- 2.16.6