-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a README with instructions for adding gallery entries
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 `<entry-name>` 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. |