search

GMOD / jbrowse-registry

JBrowse 1.x Plugin Registry
https://gmod.github.io/jbrowse-registry/
BSD 2-Clause "Simplified" License
14 stars 8 forks source link

readme

The JBrowse Plugin Directory Build Status

https://gmod.github.io/jbrowse-registry/

Registering a Plugin

We would love for you to register your plugin! It's really easy to do:

  1. Edit the plugins.yaml file, and add your plugin to the end of the list
  2. (Optional) If you have a small screenshot (approx. 200x100), please feel free to include it in the img/ folder of the repository. When adding your plugin add an image: my-plugin.png to your plugin's block.
  3. (Optional) Configure a live demo of the plugin (see the gccontent example in the demos folder, and the demo key in the plugins.yaml file.)
  4. Submit the pull request to this repo

You're done! Once the administrator accepts the PR, the plugin will be published on the site.

Building the Site

This step is for developers, and is not required for registering a plugin with the site.

make