View source for Build Instructions

[[Main Page|Back to CTK main page]]

CTK is a new and rapidly evolving system.  These instructions are valid as of october, 2010.

== Prerequisties ==

* git version 1.6.5 or later
* Qt version 4.6.3
* cmake 2.8.0

== Download ==

If you have a git hub account:

 git clone git@github.com:commontk/CTK.git

(configure your ssh id for access)

Anonymous checkout:

 git clone http://github.com/commontk/CTK.git

== Build with CMake ==

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

=== CMake Configuration ===

* set QT_QMAKE_EXECUTABLE for 4.6 development install if needed (use {path/to/qt}/bin/qmake not {path/to/qt}/qmake/qmake)
* turn on the parts of CTK you want to build

= Simple Git =

These are shortcuts for people used to the 'cvs or svn style' of source code management:

=== Checkout ===
* checkout
 git clone git@github.com:commontk/CTK.git
(or use anonymous option listed above)

=== Update ===
 git pull --rebase
=== Commit ===
* 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

* Making a repository hosted on github that can track git.vtk.org [http://wiki.github.com/pieper/SlicerVTK/]

* 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>

= Links =

List of needed tools and libraries used when building CTK:
* [http://git-scm.com/download Git]: To download source code
* [http://qt.nokia.com/downloads Qt]: Dependency needed. You need to compile it in your machine before building CTK
* [http://www.cmake.org/cmake/resources/software.html CMake]: Cross-platform build system
* [http://gnuwin32.sourceforge.net/packages/patch.htm Patch for Windows]: Needed to apply patches to external thirdparty libraries source code
* [http://www.collab.net/downloads/subversion SVN]: To update some third-party libraries automatically like PythonQt
* [http://ftp.gnu.org/non-gnu/cvs/ CVS]: To update some third-party libraries automatically like KWStyle

Optional:
* [http://www.python.org/download/ Python]: If you plan to use Scripting
* [http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc DoxyGen]: To generate documentation from source code on your machine
* [http://www.graphviz.org/Download.php GraphViz]: To generate documentation from source code on your machine