README.cmake

   1 Getting started with CMake
   2
   3 (These instructions apply to Unix-like systems, including Cygwin and Mac. To
   4 build using Visual Studio or some other IDE supported by CMake, most of the
   5 information below still applies)
   6
   7 Always compile in a separate directory to the code. For example, if the
   8 code (eg, from Git) is at /home/curt/projects/flightgear, you might create
   9 /home/curt/projects/fgbuild. Change into the new directory, and run
  10
  11     cmake ../flightger
  12
  13 To generate standard Unix Makefiles in fgbuild.
  14
  15 Probably you want to specify an install prefix:
  16
  17     cmake ../flightgear -DCMAKE_INSTALL_PREFIX=/usr
  18
  19 Note the install prefix is automatically searched for required libraries
  20 and header files, so if you install PLIB, OpenSceneGraph and SimGear to the
  21 same prefix, most configuration options are unnecessary.
  22
  23 To specify that a particular dependency is in a non-standard location, most
  24 libraries support an environment variable - eg PLIBDIR or OSG_ROOT - to
  25 allow precise selection.
  26
  27 By default, we select a release build. To create a debug build, use
  28
  29     cmake ../flightgear -DCMAKE_BUILD_TYPE=Debug
  30
  31 (or MinSizeRel, or RelWithDbg)
  32
  33 Debug builds will automatically use corresponding debug builds of required
  34 libraries, if they are available. For example you can install debug builds of
  35 SimGear and OpenSceneGraph, and a debug FlightGear build will use them.
  36
  37 (Debug builds of libraries have the 'd' suffix by default)
  38
  39 Note most IDE projects (eg Xcode and Visual Studio) support building all the
  40 build types from the same project, so you can omit the CMAKE_BUILD_TYPE option
  41 when running cmake, and simply pick the build configuration as normal in the
  42 IDE.
  43
  44 It's common to have several build directories with different build
  45 configurations, eg
  46
  47     /home/curt/projects/flightgear (the git clone)
  48     /home/curt/projects/fgdebug
  49     /home/curt/projects/fgrelease
  50     /home/curt/projects/fg-with-svn-osg
  51
  52 To set an optional feature, do
  53
  54     cmake ../flightgear -DFEATURE_NAME=ON
  55
  56 To see the variables that can be configured / are currently defined, you can
  57 run one of the GUI front ends, or the following command:
  58
  59     cmake ../flighgear -L
  60
  61 Add 'A' to see all the options (including advanced options), or 'H' to see
  62 the help for each option (similar to running configure --help under autoconf):
  63
  64     cmake ../flightgear -LH
  65
  66 Build Targets
  67
  68 For a Unix makefile build, 'make dist', 'make uninstall' and 'make test' are
  69 all available and should work as expected. 'make clean' is also as normal,
  70 but there is *no* 'make distclean' target. The equivalent is to completely
  71 remove your build directory, and start with a fresh one.
  72
  73 Adding new files to the build
  74
  75 Add source files to the SOURCES list, and headers to the HEADERS list. Note
  76 technically you only need to add source files, but omitting headers confuses
  77 project generation and distribution / packaging targets.
  78
  79 For target conditional files, you can append to the SOURCES or HEADERS lists
  80 inside an if() test, for example:
  81
  82     if(APPLE)
  83         list(APPEND SOURCES extraFile1.cxx extraFile2.cxx)
  84     endif()
  85
  86 Setting include directories
  87
  88 In any CMakeList.txt, you can do the following:
  89
  90     include_directories(${PROJECT_SOURCE_DIR}/some/path)
  91
  92 For example, this can be done in particular subdirectory, or at the project
  93 root, or an intermediate level.
  94
  95 Setting target specific compile flags, includes or defines
  96
  97 Use set_target_property(), for example
  98
  99     set_target_property(fgfs PROPERTIES
 100             COMPILE_DEFINITIONS FOO BAR=1)
 101
 102 You can set a property on an individual source file:
 103
 104     set_property(SOURCE myfile.cxx PROPERTY COMPILE_FLAGS "-Wno-unsigned-compare")
 105
 106 Detecting Features / Libraries
 107
 108 For most standard libraries (Gtk, wxWidget, Python, GDAL, Qt, libXml, Boost),
 109 cmake provides a standard helper. To see the available modules, run:
 110
 111      cmake --help-module-list
 112
 113 In the root CMakeLists file, use a statement like:
 114
 115     find_package(OpenGL REQUIRED)
 116
 117 Each package helper sets various variables such aaa_FOUND, aaa_INCLUDE_DIR,
 118 and aaa_LIBRARY. Depending on the complexity of the package, these variables
 119 might have different names (eg, OPENSCENEGRAPH_LIBRARIES).
 120
 121 If there's no standard helper for a library you need, find a similar one, copy
 122 it to CMakeModules/FindABC.cmake, and modify the code to fit. Generally this
 123 is pretty straightforward. The built-in modules reside in the Cmake 'share'
 124 directory, eg /usr/share/cmake/modules on Unix systems.
 125
 126 Note libraries support by pkg-config can be handled directly, with no need
 127 to create a custom FindABC helper.
 128
 129 Adding a new executable target
 130
 131     add_executable(myexecutable ${SOURCES} ${HEADERS})
 132     target_link_libraries(myexecutable .... libraries ... )
 133     install(TARGETS myexecutable RUNTIME DESTINATION bin)
 134
 135 (If the executable should not be installed, omit the final line above)
 136
 137 If you add an additional line
 138
 139     add_test(testname ${EXECUTABLE_OUTPUT_PATH}/myexecutable)
 140
 141 Then running 'make test' will run your executable as a unit test. The
 142 executable should return either a success or failure result code.