BUILD.md

Build and Package SlicerQReads

This document summarizes how to build and package SlicerQReads on Windows. Instructions for Linux and macOS are similar. For more details, see 3D Slicer Developer Guide on readthedocs

Prerequisites

• Microsoft Windows 7 or above recommended

• Supported Microsoft Visual Studio versions:

  • Visual Studio 2015
  • Visual Studio 2017

• CMake, version 3.11 or above

• Qt, version 5.10 or above

• Git

• Setting up your git account:

  • Create a Github account.

  • Setup your SSH keys following these instructions at the exception of step 2 where you should NOT enter a passphrase.

  • Setup your git username and your git email.

  • If not already done, email FirstName LastName <firstname.lastname@KitwareMedical.com> to be granted access to the KitwareMedical/SlicerQReads repository.

Checkout

1. Start Git Bash
2. Checkout the source code into a directory C:\W\ by typing the following commands:

cd /c
mkdir W
cd /c/W
git clone https://github.com/KitwareMedical/SlicerQReads.git SlicerQReads

Note: use short source and build directory names to avoid the maximum path length limitation.

Build

Note: The build process will take approximately 3 hours.

Option 1: CMake GUI and Visual Studio (Recommended)

1. Start CMake GUI, select source directory C:\W\SlicerQReads and set build directory to C:\W\SlicerQReads-rel.
2. Add an entry Qt5_DIR pointing to C:/Qt/${QT_VERSION}/${COMPILER}/lib/cmake/Qt5.
3. Generate the project.
4. Open C:\W\SlicerQReads-rel\SlicerQReads.sln, select Release and build the project.

Option 2: Command Line

1. Start the Command Line Prompt
2. Configure and build the project in C:\W\SlicerQReads-rel by typing the following commands:

cd C:\W\
mkdir SlicerQReads-rel
cd SlicerQReads-rel
cmake -G "Visual Studio 14 2015 Win64" -DQt5_DIR:PATH=`C:/Qt/${QT_VERSION}/${COMPILER}/lib/cmake/Qt5 ..\SlicerQReads
cmake --build . --config Release

Package

Install NSIS 2

Option 1: CMake and Visual Studio (Recommended)

1. In the C:\W\SlicerQReads-rel\Slicer-build directory, open Slicer.sln and build the PACKAGE target

Option 2: Command Line

1. Start the Command Line Prompt
2. Build the PACKAGE target by typing the following commands:

cd C:\W\SlicerQReads-rel\Slicer-build
cmake --build . --config Release --target PACKAGE