Add sample rApp generator README 26/12426/2
authoraravind.est <aravindhan.a@est.tech>
Tue, 9 Jan 2024 12:15:23 +0000 (12:15 +0000)
committeraravind.est <aravindhan.a@est.tech>
Tue, 9 Jan 2024 12:22:51 +0000 (12:22 +0000)
README file added for sample rApp generator.

Issue-ID: NONRTRIC-964
Change-Id: I841385a1a4441c4e8b36538226cd37701805ba97
Signed-off-by: aravind.est <aravindhan.a@est.tech>
sample-rapp-generator/README.md [new file with mode: 0755]

diff --git a/sample-rapp-generator/README.md b/sample-rapp-generator/README.md
new file mode 100755 (executable)
index 0000000..d437d7b
--- /dev/null
@@ -0,0 +1,26 @@
+# Sample rApp Generator
+The rApp generator supports generating the rApp package from the resources.
+
+### Sample rApp Package Structure (<mark>**It is a prototype**</mark>)
+
+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.
+