Changes between Version 16 and Version 17 of code/tools/CMake

Timestamp:

Sep 23, 2008, 12:59:36 PM (16 years ago)

Author:

rgrieder

Comment:

—

code/tools/CMake

@@ -1 +1 @@
 [[TracNav(TracNav/TOC_Development)]]
 = CMake Build System =
+CMake is a build tool which creates Makefile for you. There are also additional generators for any kind of development environment like KDevelop or Code::Blocks. [[br]]
 
 == Using CMake ==
-CMake is a build tool which created Makefile for you.
+If you only want to build Makefiles for use under linux it is very simple indeed. We recommend to build 'out-of-source', which means that the Makefiles will not pollute your source directory but be put in another folder. Simple create a new one like for instance 'build', switch to it and run 'cmake ..' (.. for subsequent path).
 {{{
-$ cmake . 
+$ mkdir build
+$ cd build
+$ cmake ..
 }}}
-With those Makefiles, the project the can be built.
+With those Makefiles, the project the can be built completely:
 {{{
-$ make -j2 all
+$ make -j3
 }}}
+The -j3 option is to use 3 parallel tasks to boost multi core systems. The rule is to use one more task than cores on your machine.
 
 
@@ -23 +27 @@
 Just as an simple example for how to write a CMakeLists.txt.[[br]]
 {{{
-PROJECT(Orxonox)
-
-SET( SRC_FILES
-        some_soource.cc
-        another_source.cc
+# Put all your source files (not headers!) in a variable to be used later
+SET( MYLIB_SRC_FILES
+  some_soource.cc
+  another_source.cc
 )
 
+# This adds the current directory to the listing of all directories to be
+# searched when looking for a header file.
 INCLUDE_DIRECOTRIES(.)
 
-ADD_LIBRARY(network ${SRC_FILES})
+# Creates the actual library. ''shared'' is dynamic under windows.
+ADD_LIBRARY(mylib shared ${MYLIB_SRC_FILES})
+
+# Link library against others. You will have to use ''${VARNAME}'' with external ones.
+TARGET_LINK_LIBRARIES(mylib ${OgreMain} myOtherLib)
 }}}
 
@@ -41 +50 @@
 
 {{{
-$ cmake . -GKDevelop3
+$ cmake .. -GKDevelop3
 }}}
 
@@ -60 +69 @@
  * Working Directory: just add {{{/bin}}}
  ''you still need to run {{{./run-script}}} the first time''
+
+== Debug CMake paths ==
+If you want to look at the paths of a library, run CMake with verbose option:
+{{{
+$ cmake -L ..
+}}}