From: aravind.est <aravindhan.a@est.tech>
Date: Tue, 9 Jan 2024 12:15:23 +0000 (+0000)
Subject: Add sample rApp generator README
X-Git-Tag: 0.1.0~44
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=3a47cb7673c603ef074579d03284a41741060756;hp=f801ec5b09a2b50e518771316d955d7c965e7d8a;p=nonrtric%2Fplt%2Frappmanager.git

Add sample rApp generator README

README file added for sample rApp generator.

Issue-ID: NONRTRIC-964
Change-Id: I841385a1a4441c4e8b36538226cd37701805ba97
Signed-off-by: aravind.est <aravindhan.a@est.tech>
---

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 (<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.
+