Difference between revisions of "Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions"

From Slicer Wiki
Jump to: navigation, search
m
m
Line 33: Line 33:
 
   
 
   
 
<li><p>[[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager|Check that the extension can be installed]].</p></li>
 
<li><p>[[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager|Check that the extension can be installed]].</p></li>
 +
 +
<li><p>If you consider your extension ready for distribution, follow [[Documentation/{{documentation/version}}/Developers/Tutorials/Contribute_Extension_Description_File|these instructions.]]</p></li>
  
 
</ol>
 
</ol>

Revision as of 21:23, 12 June 2013

Home < Documentation < Nightly < Developers < Tutorials < BuildTestPackageDistributeExtensions

Step-by-step: How to create, publish and distribute an extension ?

  1. Scan through the user and developer extension FAQs

  2. (Optionally) Present your extension(s) on the slicer developers list to check if other developer are working on a similar project, to seek for advice or to reach out for potential collaboration.

  3. Build Slicer application

  4. Use the Wizard to easily create an extension containing one or more Slicer modules.

  5. Create a repository to save your work. We recommend GitHub

  6. Implement your extension. Hack, hack, hack :) and commit often.

  7. Create a documentation page for your extension.

  8. If not alreadt done, send an email on the slicer developers list asking to be granted write permission on the experimental folder.

  9. Create an account on the extension server and obtain an API Key. You can then used your midas login and api key to substitute <YOUR-MIDAS-LOGIN> and <YOUR-MIDAS-APIKEY> in the examples.

  10. Assuming the source code of your extension is located in folder MyExtension, you could upload your extension doing:

    $ mkdir MyExtension-build
    $ cd MyExtension-build
    $ cmake -DCMAKE_BUILD_TYPE:STRING=Release -DMIDAS_PACKAGE_EMAIL:STRING=<YOUR-MIDAS-LOGIN> -DMIDAS_PACKAGE_API_KEY:STRING=<YOUR-MIDAS-APIKEY> -DSlicer_DIR:PATH=/path/to/Slicer-Superbuild/Slicer-build ../MyExtension
    $ make ExperimentalUpload
    

  11. Check submission results on this page: http://slicer.cdash.org/index.php?project=Slicer4#Extensions-Experimental

  12. Check that the extension can be installed.

  13. If you consider your extension ready for distribution, follow these instructions.