Difference between revisions of "Documentation/Nightly/Developers/Tutorials/Contribute Extension Description File using Extension Wizard"
From Slicer Wiki
m |
m |
||
| Line 16: | Line 16: | ||
* Extension has been built, tested and installed on at least one platform (Linux, MacOSX or Windows) | * Extension has been built, tested and installed on at least one platform (Linux, MacOSX or Windows) | ||
| − | + | = Conventions = | |
| − | |||
| − | |||
* Terminal command - Block like the one below indicates that the command should be executed in a terminal. | * Terminal command - Block like the one below indicates that the command should be executed in a terminal. | ||
| Line 27: | Line 25: | ||
{{pre2|<nowiki>$ echo "This is a command"</nowiki>}} | {{pre2|<nowiki>$ echo "This is a command"</nowiki>}} | ||
| + | |||
| + | = Contributing a new extension / Requesting an extension update = | ||
| + | |||
| + | Typing this command will create a pull request on ExtensionsIndex repository. | ||
| + | |||
| + | <ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;"> | ||
| + | <li>Make sure the latest changes associated with your extension have been pushed in your extension repository.</li> | ||
| + | </ol> | ||
== Extensions built against Slicer trunk == | == Extensions built against Slicer trunk == | ||
| − | |||
| − | |||
{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}} | {{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}} | ||
== Extensions build against Slicer {{Documentation/currentversion}} == | == Extensions build against Slicer {{Documentation/currentversion}} == | ||
| − | |||
| − | |||
{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute --target </nowiki>{{Documentation/currentversion}}<nowiki> ~/Slicer-MyExtension/</nowiki>}} | {{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute --target </nowiki>{{Documentation/currentversion}}<nowiki> ~/Slicer-MyExtension/</nowiki>}} | ||
Revision as of 13:24, 4 June 2014
Home < Documentation < Nightly < Developers < Tutorials < Contribute Extension Description File using Extension Wizard
|
For the latest Slicer documentation, visit the read-the-docs. |
Contents
Overview
This page describe how to easily contribute an extension description file using the ExtensionWizard. The wizard automates the manual steps documented here.
Definitions
- Extension description file: This is a text file with extension
.s4extthat fully described an extension. More details here.
- ExtensionsIndex: This is a repository containing a list of extension description files
*.s4ext. These description files are used by the Slicer extensions build system to build, test, package and upload extensions on the extensions server. More details here
Prerequisites
- Extension belongs to Category 1 or Category 2 as described in Slicer requirements
- Extension has been built, tested and installed on at least one platform (Linux, MacOSX or Windows)
Conventions
- Terminal command - Block like the one below indicates that the command should be executed in a terminal.
- On Windows, Git Bash is expected (not the Windows command line). Need help ?
$ echo "This is a command"
Contributing a new extension / Requesting an extension update
Typing this command will create a pull request on ExtensionsIndex repository.
- Make sure the latest changes associated with your extension have been pushed in your extension repository.
Extensions built against Slicer trunk
$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/
Extensions build against Slicer 4.10
$ bin/slicerExtensionWizard --contribute --target 4.10 ~/Slicer-MyExtension/
