View source for Programming Howto:Building BCI2000

This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.

==Prerequisites==
#A C++ compiler. Currently, MSVC 2012 through 2017 are supported.
#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.
#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.

==How to build==
===1. Start CMake===
In the BCI2000 build directory, double-click '''Configure.sh.bat'''.
===2. If using Qt on Windows, point CMake to it===
#In the CMake GUI, click "Add Entry".
#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".
#Under Value, enter the path to your Qt distribution's "lib/cmake/Qt5" directory.
E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.
===3. Click "Configure"===
From the list of compilers, choose the compiler that matches the Qt distribution chosen above.
===4. Choose build options===
#Make sure that "Grouped" is checked in the GUI, and "Advanced" is unchecked.
#Under the "BUILD" section, you may choose which parts of BCI2000 to build. Typically, you will want to have "BUILD_CONTRIB" checked.
#Under "EXTENSIONS", choose which extensions to include into the build.
===5. Click "Generate"===
A project/solution file will be created inside the BCI2000 build directory. Double-click it to open it in the IDE.
===6. Build BCI2000 in full, or partially===
In the IDE, choose which projects to build. You may right-click individual projects, or groups of projects, and choose "build" from the context menu.

[[Category:Howto]][[Category:Development]]