Difference between revisions of "Portal:Getting Started"

From MNE-CPP Wiki
Jump to: navigation, search
Line 10: Line 10:
 
#:* Tools/QtCreator
 
#:* Tools/QtCreator
 
# Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account.
 
# Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account.
# Run the mne-cpp.pro file with the QtCreator. Select the Release mode.
+
# Run the mne-cpp.pro file with the QtCreator. Select the Release mode
# Right mouse click on the top level tree item mne-cpp, then select Run qmake.
+
# Right mouse click on the top level tree item mne-cpp, then select Run qmake
 
# Right mouse click again and then hit Build. The build porcess may take some time depending on your computer setup.  
 
# Right mouse click again and then hit Build. The build porcess may take some time depending on your computer setup.  
 
# After the build process is finished, check out the mne-cpp/bin folder. All applications and libraries should have been created throughout the build process.
 
# After the build process is finished, check out the mne-cpp/bin folder. All applications and libraries should have been created throughout the build process.
# In case you do not have a debugger setup (for windows):
+
# In case you do not have a debugger (for windows):
## Go to SDK webpage.
+
## Go to the [https://msdn.microsoft.com/de-DE/windows/desktop/bg162891 Windows SDK download website]
## Download and install SDK.
+
## Download and install the SDK (during the installation, select the Debugging Tools for Windows box and clear all the other boxes)
## Select debugger under Kits in QtCreator.
+
## Select debugger under Kits in QtCreator
## The first time you use the debugger, you might see the following message.
+
## The first time you use the debugger, you might see the following message
  
'''Next steps:'''
+
'''Further reading:'''
  
Tutorial on how to create your first application
+
* Tutorial on how to create your first application
 
+
* Tutorial on how to create your first MNE-X plugin
Tutorial on how to create your first MNE-X plugin
+

Revision as of 10:53, 4 January 2016

This page will show you how to setup the mne-cpp project in order to build and develop your own features with or based on the mne-cpp framework.

Getting the mne-cpp source code compiled:

  1. Download the current Qt version:
    1. Go to the Qt download website
    2. Select the appropriate version based on the compiler and platform you use. For example if you are using the Microsoft Visual Studio 2013 Compiler on a Windows 32bit system, select the "Qt 5.5.1 for Windows 32-bit (VS 2013, 823 MB)" version.
  2. Install the Qt version with the minimum of the following features:
    • Qt/Pre-compiled Qt
    • Qt/Qt3D
    • Tools/QtCreator
  3. Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account.
  4. Run the mne-cpp.pro file with the QtCreator. Select the Release mode
  5. Right mouse click on the top level tree item mne-cpp, then select Run qmake
  6. Right mouse click again and then hit Build. The build porcess may take some time depending on your computer setup.
  7. After the build process is finished, check out the mne-cpp/bin folder. All applications and libraries should have been created throughout the build process.
  8. In case you do not have a debugger (for windows):
    1. Go to the Windows SDK download website
    2. Download and install the SDK (during the installation, select the Debugging Tools for Windows box and clear all the other boxes)
    3. Select debugger under Kits in QtCreator
    4. The first time you use the debugger, you might see the following message

Further reading:

  • Tutorial on how to create your first application
  • Tutorial on how to create your first MNE-X plugin