Documentation/Nightly/Developers/Build Instructions/Configure - Revision history

Sam.horvath: /* Unix-like */ Update unix-like build instructions

2020-06-01T14:29:53Z

Unix-like: Update unix-like build instructions

Sam.horvath: /* Windows */ Update Qt/Compiler in build instructions

2020-06-01T14:26:21Z

Windows: Update Qt/Compiler in build instructions

Show changes

Lasso: /* Windows */

2019-06-30T16:22:23Z

Windows

Gregsharp: /* Windows */

2019-06-30T15:07:27Z

Windows

JChris.FillionR: /* Windows */

2019-04-15T23:03:48Z

Windows

JChris.FillionR: /* Windows */

2019-04-15T23:03:36Z

Windows

Lasso: /* Windows */

2019-04-15T19:01:56Z

Windows

Lasso: /* Windows */

2019-04-15T15:12:02Z

Windows

JChris.FillionR: /* CONFIGURE and generate Slicer solution files */

2019-02-01T01:06:52Z

CONFIGURE and generate Slicer solution files

Lasso: /* Windows */

2018-09-30T12:42:11Z

Windows

@@ Line 84: / Line 84: @@
 mkdir Slicer-SuperBuild-Debug
 cd Slicer-SuperBuild-Debug
-cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DQt5_DIR:PATH=/path/to/Qt5.11.0/5.11.0/gcc_64/lib/cmake/Qt5 ../Slicer
+cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DQt5_DIR:PATH=/path/to/Qt5.15.0/5.15.0/gcc_64/lib/cmake/Qt5 ../Slicer
 </pre>
 where you replace ''/path/to/QtSDK'' with the real path on your machine where QtSDK is located

@@ Line 32: / Line 32: @@
 '''Recommended''': run ''CMake (cmake-gui)'' from the Windows Start menu
-* Set the build directory. Use a very short path, for example: <code>C:\S4</code> or <code>C:\S4D</code>.
+* Set the build directory. Use a very short path, for example: <code>C:\D\S4</code> for source code and for <code>C:\D\S4D</code> build directory are known to work.
-** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters.
+** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], it is strongly recommended to choose a build directory that is no longer than 10 characters. If a longer path is used then build may or may not succeed.
 ** You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.
 * Select your compiler: Visual Studio 14 2015 Win64

@@ Line 32: / Line 32: @@
 '''Recommended''': run ''CMake (cmake-gui)'' from the Windows Start menu
-* Set the build directory. For example: <code>C:\Slicer-SuperBuild-Debug</code> or <code>C:\Slicer-SuperBuild-Release</code>.
+* Set the build directory. Use a very short path, for example: <code>C:\S4</code> or <code>C:\S4D</code>.
-** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters (for example <code>c:\work\Slicer\Slicer-SuperBuild</code> may work). In case of ''any'' build error, use very short directory names: C:\D\S4 for source directory, C:\D\S4D for debug build, C:\D\S4R for release build.
+** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters.
 ** You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.
 * Select your compiler: Visual Studio 14 2015 Win64

@@ Line 49: / Line 49: @@
 '''Alternative option''': Configure and build using command-line or batch file
-Instead of using ''CMake (cmake-gui)'', it is also possible to configure by creating a .bat file that contains command-line instructions and run this .bat file each time a Slicer needs to be re-built. The examples below assume Slicer source code is in <code>C:\S4</code> folder and Qt-5.10 is installed in default location.
+Instead of using ''CMake (cmake-gui)'', it is also possible to configure by creating a .bat file that contains command-line instructions and run this .bat file each time a Slicer needs to be re-built. The examples below assume Slicer source code is in <code>C:\D\S4</code> folder and Qt-5.10 is installed in default location.
 Visual Studio 2015 in Release mode:

@@ Line 33: / Line 33: @@
 '''Recommended''': run ''CMake (cmake-gui)'' from the Windows Start menu
 * Set the build directory. For example: <code>C:\Slicer-SuperBuild-Debug</code> or <code>C:\Slicer-SuperBuild-Release</code>.
-** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters (for example <code>c:\work\Slicer\Slicer-SuperBuild</code> may work). In case of ''any'' build error, use very short directory names: C:\S4 for source directory, C:\S4D for debug build, C:\S4R for release build.
+** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters (for example <code>c:\work\Slicer\Slicer-SuperBuild</code> may work). In case of ''any'' build error, use very short directory names: C:\D\S4 for source directory, C:\D\S4D for debug build, C:\D\S4R for release build.
 ** You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.
 * Select your compiler: Visual Studio 14 2015 Win64

@@ Line 71: / Line 71: @@
 mkdir C:\D\S4R
 cd /d C:\D\S4R
-"C:\Program Files\CMake\bin\cmake.exe" -G "Visual Studio 15 2017 Win64" -DQt5_DIR:PATH=C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5 C:\D\S4
+"C:\Program Files\CMake\bin\cmake.exe" -G "Visual Studio 15 2017 Win64" -T "v140" -DQt5_DIR:PATH=C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5 C:\D\S4
 "C:\Program Files\CMake\bin\cmake.exe" --build . --config Release
 </pre>

@@ Line 37: / Line 37: @@
 * Select your compiler: Visual Studio 14 2015 Win64
 * <b>Do not configure yet.</b>
-* Add <code>Qt5_DIR</code> variable pointing to Qt5 folder such as <code>C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5</code>.
+* Add <code>Qt5_DIR</code> variable pointing to Qt5 folder such as <code>C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5</code>: click ''Add entry'' button, set ''Name'' to ''Qt5_DIR'', ''Type'' to ''PATH'', and ''Value'' to the Qt5 folder.
 * Configure
 * Click generate then close cmake-gui.

@@ Line 4: / Line 4: @@
 There are many ways of customizing Slicer's user interface or feature set. This section describes how a custom Slicer build can be configured at build-time. See an overview of various other options in [http://www.na-mic.org/Wiki/images/b/b0/Slicelets2016.pdf this presentation].
-You can configure and generate Slicer solution files using either <code>ccmake</code> or <code>cmake-gui</code>.
+You can configure and generate Slicer solution files using either <code>ccmake</code> or <code>cmake-gui</code>. To streamline this process, you can also use the [https://github.com/KitwareMedical/SlicerCustomAppTemplate SlicerCustomAppTemplate] project maintained by Kitware.
 <!--

@@ Line 30: / Line 30: @@
 === Per-platform instructions===
 ==== Windows ====
-*'''Recommended''': run ''CMake (cmake-gui)'' from the Windows Start menu
-** Set the build directory. For example: <code>C:\Slicer-SuperBuild-Debug</code> or <code>C:\Slicer-SuperBuild-Release</code>.
+'''Recommended''': run ''CMake (cmake-gui)'' from the Windows Start menu
-*** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters (for example <code>c:\work\Slicer\Slicer-SuperBuild</code> may work). In case of ''any'' build error, use very short directory names: C:\S4 for source directory, C:\S4D for debug build, C:\S4R for release build.
+* Set the build directory. For example: <code>C:\Slicer-SuperBuild-Debug</code> or <code>C:\Slicer-SuperBuild-Release</code>.
-*** You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.
+** Because Windows [http://msdn.microsoft.com/en-us/library/aa365247%28VS.85%29.aspx#maxpath doesn't support file path longer than 260 characters] and has a [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2014/016113.html maximum command line length], please make sure that the total path name of your <code>Slicer-build</code> directory is no longer than 50 characters (for example <code>c:\work\Slicer\Slicer-SuperBuild</code> may work). In case of ''any'' build error, use very short directory names: C:\S4 for source directory, C:\S4D for debug build, C:\S4R for release build.
-** Select your compiler: Visual Studio 14 2015 Win64
+** You cannot use the same build tree for both release or debug mode builds. If both build types are needed, then the same source directory can be used, but a separate build directory should be created and configured for each build type.
-** <b>Do not configure yet.</b>
+* Select your compiler: Visual Studio 14 2015 Win64
-** Add <code>Qt5_DIR</code> variable pointing to Qt5 folder such as <code>C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5</code>.
+* <b>Do not configure yet.</b>
-** Configure
+* Add <code>Qt5_DIR</code> variable pointing to Qt5 folder such as <code>C:\Qt\5.10.0\msvc2015_64\lib\cmake\Qt5</code>.
-** Click generate then close cmake-gui.
+* Configure
-** If building in release mode:
+* Click generate then close cmake-gui.
-*** Open the top-level Slicer.sln file in the build directory in Visual Studio
+* If building in release mode:
-*** Set active configuration to Release. Visual Studio will select Debug build configuration by default when you first open the solution in the Visual Studio GUI. If you build Slicer in release mode and accidentally forget to switch the build configuration to Release then the build will fail. Note: you can avoid this manual configuration mode selection by setting <code>CMAKE_CONFIGURATION_TYPES</code> to <code>Release</code> in cmake-gui.
+** Open the top-level Slicer.sln file in the build directory in Visual Studio
-** If building in debug mode:
+** Set active configuration to Release. Visual Studio will select Debug build configuration by default when you first open the solution in the Visual Studio GUI. If you build Slicer in release mode and accidentally forget to switch the build configuration to Release then the build will fail. Note: you can avoid this manual configuration mode selection by setting <code>CMAKE_CONFIGURATION_TYPES</code> to <code>Release</code> in cmake-gui.
-*** Start Visual Studio using the Slicer launcher as described in [[Documentation/{{documentation/version}}/Developers/Tutorials/Debug_Instructions|Step-by-step debug instuctions]]
+* If building in debug mode:
-** Build the ALL_BUILD project
+** Start Visual Studio using the Slicer launcher as described in [[Documentation/{{documentation/version}}/Developers/Tutorials/Debug_Instructions|Step-by-step debug instuctions]]
 ==== Unix-like ====