@@ -5,18 +5,18 @@ the functionality of your plugin. Its content will be rendered on your plugin's
5
5
napari hub page.
6
6
7
7
The sections below are given as a guide for the flow of information only, and
8
- are in no way prescriptive. You should feel free to merge, remove, add and
9
- rename sections at will to make this document work best for your plugin.
8
+ are in no way prescriptive. You should feel free to merge, remove, add and
9
+ rename sections at will to make this document work best for your plugin.
10
10
11
11
## Description
12
12
13
- This should be a detailed description of the context of your plugin and its
13
+ This should be a detailed description of the context of your plugin and its
14
14
intended purpose.
15
15
16
16
If you have videos or screenshots of your plugin in action, you should include them
17
- here as well, to make them front and center for new users.
17
+ here as well, to make them front and center for new users.
18
18
19
- You should use absolute links to these assets, so that we can easily display them
19
+ You should use absolute links to these assets, so that we can easily display them
20
20
on the hub. The easiest way to include a video is to use a GIF, for example hosted
21
21
on imgur. You can then reference this GIF as an image.
22
22
@@ -59,7 +59,7 @@ anywhere, feel free to also include this information here.
59
59
This section should go through step-by-step examples of how your plugin should be used.
60
60
Where your plugin provides multiple dock widgets or functions, you should split these
61
61
out into separate subsections for easy browsing. Include screenshots and videos
62
- wherever possible to elucidate your descriptions.
62
+ wherever possible to elucidate your descriptions.
63
63
64
64
Ideally, this section should start with minimal examples for those who just want a
65
65
quick overview of the plugin's functionality, but you should definitely link out to
@@ -72,8 +72,8 @@ for the majority of plugins. They will include instructions to pip install, and
72
72
to install via napari itself.
73
73
74
74
Most plugins can be installed out-of-the-box by just specifying the package requirements
75
- over in `setup.cfg`. However, if your plugin has any more complex dependencies, or
76
- requires any additional preparation before (or after) installation, you should add
75
+ over in `setup.cfg`. However, if your plugin has any more complex dependencies, or
76
+ requires any additional preparation before (or after) installation, you should add
77
77
this information here.
78
78
79
79
## Getting Help
0 commit comments