Skip to content

Commit

Permalink
Add a README with instructions for adding gallery entries
Browse files Browse the repository at this point in the history
  • Loading branch information
Oddant1 committed Oct 24, 2024
1 parent 733db63 commit e3b1336
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Instructions for adding a visualization to the QIIME 2 View Gallery

Open a PR against this repo adding the following:

```
/gallery/
|__<entry-name>/
|__info.json
|__thumb.png
```

## info.json contents

`info.json` must contain the following key: value pairs.

```
title: The name of your gallery entry
desc: A short description of your gallery entry
href: The URL of your visualization (This URL MUST have appropriate CORS headers set)
```

## thumb.png

The .png you wish to use as the thumbnail for your visualization in the gallery. This should be a screenshot of your visualization.

## /gallery/index.json

Edit `/gallery/index.json` adding `&lt;entry-name&gt;` to the end of the list.

## Example PR

An [example PR](https://github.com/qiime2/q2view-gallery/pull/8) showing the addition of an entry to the gallery in a single atomic commit.

0 comments on commit e3b1336

Please sign in to comment.