Build Instructions

From Commontk
Revision as of 20:21, 13 April 2023 by JChris.FillionR (talk | contribs) (Update Build_Instructions removing obsolete references)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Home < Build Instructions

The following instructions are valid as of October 2012 (if something is incorrect, please report an issue).


  • git version 1.6.5 or later
  • Qt version 4.x or 5.x
  • CMake 3.0 or later


Anonymous checkout behind a firewall CTK developer with write access
git clone
git clone

Build with CMake

mkdir CTK-superbuild
cd CTK-superbuild
ccmake ../CTK

CMake Configuration

  • For Qt5, set Qt5_DIR to C:\Qt\5.15.2\msvc2019_64\lib\cmake\Qt5
  • For Qt4, set QT_QMAKE_EXECUTABLE (qmake is usually found in the bin folder)
  • turn on the parts of CTK you want to build

How to use CTK ?

See the Examples project that illustrates how CTK can be integrated into applications.


Simple Git

See also


  • checkout
git clone

(or use anonymous option listed above)


git pull --rebase


  • commit (commit is to local version, push sends it to upstream server)
git add <changed files>
git commit -m <message>
git push

Intermediate Git

  • check update before merging (look at diff):
git fetch
git diff origin master
git rebase
  • If you have changes pending that you aren't ready to commit, you can't rebase on top of them unless you do this:
git stash
git pull --rebase
git stash pop
  • to get the code from a branch
git clone <repository> <dir>
cd <dir>
git checkout origin/<branchname>


List of needed tools and libraries used when building CTK:

  • Git: To download source code
  • Qt: Dependency required.
  • CMake: Cross-platform build system
  • Patch for Windows: Needed to apply patches to external thirdparty libraries source code


  • Python: If you plan to use Scripting
  • DoxyGen: To generate documentation from source code on your machine
  • GraphViz: To generate documentation from source code on your machine