Difference between revisions of "Documentation/Nightly/Developers/Tutorials/Contribute Extension Description File using Extension Wizard"

From Slicer Wiki
Jump to: navigation, search
Line 13: Line 13:
  
 
= Contributing a new extension / Requesting an extension update =
 
= Contributing a new extension / Requesting an extension update =
 +
 +
<p>'''Linux or MacOSX:''' Start a terminal.</p>
 +
<p>'''Windows:''' Start <code>Git Bash</code> (not the Windows command line). [https://help.github.com/articles/set-up-git#platform-windows Need help ?]</p>
  
 
== Extensions built against Slicer trunk ==
 
== Extensions built against Slicer trunk ==
Line 18: Line 21:
 
The following instruction describes how to contribute extension description file for an extension being built against slicer trunk.
 
The following instruction describes how to contribute extension description file for an extension being built against slicer trunk.
  
<ol start="1" style="list-style-type: decimal;">
+
{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}}
 
 
<li>
 
  <p>'''Linux or MacOSX:''' Start a terminal.</p>
 
  <p>'''Windows:''' Start <code>Git Bash</code> (not the Windows command line). [https://help.github.com/articles/set-up-git#platform-windows Need help ?]</p>
 
</li>
 
 
 
<li>{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/</nowiki>}}</li>
 
 
 
</ol>
 
  
 
== Extensions build against Slicer {{Documentation/currentversion}} ==
 
== Extensions build against Slicer {{Documentation/currentversion}} ==
  
* The following instruction describes how to contribute extension description file for an extension being built against slicer {{Documentation/currentversion}}.  
+
The following instruction describes how to contribute extension description file for an extension being built against slicer {{Documentation/currentversion}}.  
  
{|width = "100%"
+
{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute --target </nowiki>{{Documentation/currentversion}}<nowiki>  ~/Slicer-MyExtension/</nowiki>}}
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Linux or MacOSX
 
! width="50%" style="border-bottom: 1px solid darkgrey;font-size: 75%;"| Windows
 
|-
 
| valign="top" |
 
Start a terminal.
 
| valign="top" |
 
Start Git Bash (not the Windows command line). [https://help.github.com/articles/set-up-git#platform-windows Need help ?]
 
|-
 
|colspan="2"| {{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute --target </nowiki>{{Documentation/currentversion}}<nowiki>  ~/Slicer-MyExtension/</nowiki>}}
 
|}
 

Revision as of 03:56, 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.


Definitions

  • Extension description file: This is a text file with extension .s4ext that 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)

Contributing a new extension / Requesting an extension update

Linux or MacOSX: Start a terminal.

Windows: Start Git Bash (not the Windows command line). Need help ?

Extensions built against Slicer trunk

The following instruction describes how to contribute extension description file for an extension being built against slicer trunk.

$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/

Extensions build against Slicer 4.10

The following instruction describes how to contribute extension description file for an extension being built against slicer 4.10.

$ bin/slicerExtensionWizard --contribute --target 4.10  ~/Slicer-MyExtension/