Difference between revisions of "Programming Howto:Deploy a Release version of a BCI2000 Module"

From BCI2000 Wiki
Jump to: navigation, search
(Created page with "Double-click the "Configure.sh.cmd" script in the BCI2000 build directory to start the CMake GUI File:deploy_module_1.png Make sure "USE_APPLICATION_BUNDLES" is checked,...")
 
Line 1: Line 1:
Double-click the "Configure.sh.cmd" script in the BCI2000 build directory to start the CMake GUI
+
==Back==
 +
To [[Programming Howto:Building and Customizing BCI2000|this howto's overview page]].
  
[[File:deploy_module_1.png]]
+
==Globally enable application bundling==
 +
Double-click the "Configure.sh.cmd" script in the BCI2000 build directory to start the CMake GUI.
  
Make sure "USE_APPLICATION_BUNDLES" is checked, and click "Generate"
+
[[File:deploy_module_1.png|center]]
  
[[File:deploy_module_2.png]]
+
Make sure "USE_APPLICATION_BUNDLES" is checked, and click "Generate".
  
Switch to VisualStudio and click "Reload" if prompted
+
[[File:deploy_module_2.png|center]]
  
[[File:deploy_module_3.png]]
+
Switch to VisualStudio and click "Reload" if prompted.
  
In your module's CMakeLists.txt, disable any "NOBUNDLE" option
+
[[File:deploy_module_3.png|center]]
  
[[File:deploy_module_4.png]]
+
==Enable application bundling for your module==
 +
In your module's CMakeLists.txt, disable any "NOBUNDLE" option.
  
Switch to Release mode
+
[[File:deploy_module_4.png|center]]
  
[[File:deploy_module_5.png]]
+
==Rebuild your module==
 +
Switch to Release mode.
  
Right-click your module, and choose "Build" from the context menu
+
[[File:deploy_module_5.png|center]]
  
[[File:deploy_module_6.png]]
+
Right-click your module, and choose "Build" from the context menu.
  
When the bundle is created, a list of contained files will be shown
+
[[File:deploy_module_6.png|center]]
  
[[File:deploy_module_7.png]]
+
When the bundle is created, a list of contained files will be shown.
 +
 
 +
[[File:deploy_module_7.png|center]]
  
 
The bundle looks like an executable ...
 
The bundle looks like an executable ...
  
[[File:deploy_module_8.png]]
+
[[File:deploy_module_8.png|center]]
 +
 
 +
... but when appending a ".zip" extension, you can see it's a ZIP file as well.
 +
 
 +
[[File:deploy_module_9.png|center]]
  
... but when appending a ".zip" extension, you can see it's a ZIP file as well
+
This allows you to move the module to a different machine without having to install additional software there.
  
[[File:deploy_module_9.png]]
+
'''NOTE:''' This does not work for '''debug builds''', which will always depend on components installed alongside VisualStudio.
  
 
==See also==
 
==See also==

Revision as of 15:42, 16 August 2018

Back

To this howto's overview page.

Globally enable application bundling

Double-click the "Configure.sh.cmd" script in the BCI2000 build directory to start the CMake GUI.

Deploy module 1.png

Make sure "USE_APPLICATION_BUNDLES" is checked, and click "Generate".

Deploy module 2.png

Switch to VisualStudio and click "Reload" if prompted.

Deploy module 3.png

Enable application bundling for your module

In your module's CMakeLists.txt, disable any "NOBUNDLE" option.

Deploy module 4.png

Rebuild your module

Switch to Release mode.

Deploy module 5.png

Right-click your module, and choose "Build" from the context menu.

Deploy module 6.png

When the bundle is created, a list of contained files will be shown.

Deploy module 7.png

The bundle looks like an executable ...

Deploy module 8.png

... but when appending a ".zip" extension, you can see it's a ZIP file as well.

Deploy module 9.png

This allows you to move the module to a different machine without having to install additional software there.

NOTE: This does not work for debug builds, which will always depend on components installed alongside VisualStudio.

See also

Programming Howto:Building and Customizing BCI2000