...
To help users decide whether to install your App, create a markdown file to package with your App. IGB will display it in the right side panel of the IGB App Manager.
Be sure to includeexplain:
- High-level overview of what What the App does
- How to run the App within IGB
...
To add documentation to your App:
- Create a markdown file file (e.g., AppDescription.md)
- Save it in the top level of your IGB App project (same level as pom.xml)
- Indicate the name of the Markdown file in your pom.xml file using the tag app.description.
...