Merge "Sample rApp package for ics producer"
[nonrtric/plt/rappmanager.git] / sample-rapp-generator / README.md
1 # Sample rApp Generator
2 The rApp generator supports generating the rApp package from the resources.
3
4 ### Sample rApp Package Structure (<mark>**It is a prototype**</mark>)
5
6 This is a sample structure, and rApp package contents can be placed depending on the requirements of rApp.
7
8 ![Image](../docs/images/rApp-package-1.png "Rapp package")
9 ![Image](../docs/images/rApp-package-2.png "Rapp package")
10
11 ### Generate rApp package
12
13 rApp package generator script takes the directory name as an argument and generates the rApp package with the contents inside the given directory.
14
15 #### Generating in Linux environment
16
17 > ./generate.sh rapp-all
18
19
20 #### Generating in Windows environment
21
22 > generate.bat rapp-all
23
24
25 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.
26