IGB can display formatted text in the right panel of the IGB App Manager. Use this section of the App Manager to describe your App to potential users.

...

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.

toc 

Create README.md file to include with your App

...

<instructions>
  <Bundle-Description>${bundleDescription}</Bundle-Description> 
</instructions>

...

Add bundle-markdown-encoder plugin (from IGB project)

...

<plugin>
    <groupId>com.lorainelab</groupId>
    <artifactId>bundle-markdown-encoder</artifactId>
    <executions>
       <execution>
          <goals>
            <goal>encodeMarkdown</goal>
          </goals>
       </execution> 
    </executions>
</plugin>  

...

Supported Markdown

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

However, before deploying your Markdown you should test it with the App Manager. 

Example README.md for an IGB App

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

Here is [a link](http://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](http://transvar.org/~aloraine/Plant.png "A Plant")

...