...

To help users decide whether to install your App, create a short README.md ( markdown ) file to package with your App. IGB will display it in the right side panel of the IGB App Manager. 

Be sure to include:

• High-level overview of what the App does
• How to run the App within IGB

Most Apps add menus, tabs, or other new graphical user interface components to the IGB interface. If your App does this, tell users where to find these new elements and how to use them. You can also link out to external Web sites or include images. 

Create

...

markdown file to include with your App

To add documentation to your App:

• Create a markdown file named README.mdfile 
• 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. 
  
  

  <properties>
	...
    <app.description>AppDescription.md</app.description>
	...
  </properties>

Add Bundle-Description tag to pom.xml

...

<pluginRepositories>
	<pluginRepository>
		<id>repo3</id>
		<url>http://maven2    <pluginRepository>
      <id>maven-releases</id> 
      <url>https://nexus.bioviz.org/repository/repo3<maven-releases</url>
	    </pluginRepository>
</pluginRepositories> 

Supported Markdown

The IGB App Manager should honor supports github-flavored markdown, described here: https://help.github.com/articles/github-flavored-markdown/

...

Note that currently, if you would like to reference an image in your README.md, you'll need to use an absolute URL to wherever the image is hosted. You'll also need to ensure that the image URL is always accessible.  We recommend that if you are hosting your own App repository, you keep the images you need there. This will ensure that if users can download your App to install it, IGB can also download the image. Also see Share your App - the IGB App Store

Example README.md for an IGB App

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

Here is [a link](httphttps://www.bioviz.org)

An unordered list:

* Item one
* Item two

A table:

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |

* * *

An image:

![A Plant](httphttps://transvarexample.org/~alorainecom/Plant.png "A Plant")

Here's how it looks in the App Manager:

...