Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 20 and Version 21 of code/Buildsystem


Ignore:
Timestamp:
Apr 12, 2017, 10:11:42 PM (3 years ago)
Author:
landauf
Comment:

fixed links and formatting

Legend:

Unmodified
Added
Removed
Modified
  • code/Buildsystem

    v20 v21  
    11= The Orxonox Build System =
    2 [[TracNav(TracNav/TOC_Development)]]
    32
    43We use [http://www.cmake.org CMake] to configure the build. It can either generate makefiles or project files (Visual Studio, KDevelop, Code::Blocks, etc.). More information on which generator they support can be found on their website. Orxonox officially supports UNIX makefiles, Code::Blocks projects, Visual Studio solutions and XCode project files. [[br]]
     
    87Orxonox has of course some library dependencies which you will have to get beforehand. If you are compiling on Windows or OS X, we strongly recommend to use our precompiled archives, supplied on the [wiki:download] page. These dependencies have been tested and compiled in an optimal way.[[br]]
    98
    10 This is a list of requirements: [wiki:Libraries] (all libraries with source 'external')
     9This is a list of requirements: [wiki:libs Libraries] (all libraries with source 'external')
    1110
    1211On Windows, you will also need at least the DirectX 8 SDK (necessary parts in included in the dependency archives).
     
    2928If you wish to have more options than listed here, you will have to consult an Orxonox developer or the CMake online docs.
    3029
    31 || Variable Name || Availability || Default Value || Description ||
    32 
    33 || CMAKE_BUILD_TYPE ||  || Debug || Debug, Release, RelWithDebInfo, RelForDevs, MinSizeRel ||
    34 
    35 || CMAKE_INSTALL_PREFIX || || /usr (UNIX), %ProgramFiles%\Orxonox (Windows) || Where you would like to install Orxonox. See the install sections below for more information ||
    36 
     30||= Variable Name =||= Availability =||= Default Value =||= Description =||
     31|| CMAKE_BUILD_TYPE ||  || Debug || Debug, Release, !RelWithDebInfo, !RelForDevs, !MinSizeRel ||
     32|| CMAKE_INSTALL_PREFIX || || /usr (UNIX), %!ProgramFiles%\Orxonox (Windows) || Where you would like to install Orxonox. See the install sections below for more information ||
    3733|| DEPENDENCY_PACKAGE_DIR || Windows, OS X || ../dependencies/ or dependencies/ relative to the source dir || The directory in which the precompiled dependencies can be found (version.txt has to be there!) ||
    38 
    3934|| DISABLE_COMPILATIONS || || false || Disables compiling multiple designated source files as a single translation unit ||
    40 
    4135|| EXTRA_COMPILER_WARNINGS || || false || "--Wextra --Wno-unused-parameter" for GCC and "-W4" for MSVC ||
    42 
    4336|| INSTALL_COPYABLE || || false (Unix), true (Windows) || Use relative paths for the installation version. See below in the Installation section for more information. ||
    44 
    4537|| EXTERNAL_DATA_DIRECTORY || || data_extern/ or ../data_extern/ from the src/ directory || Specifies the location of the media files (textures, scripts, maps, etc.). The search routine looks for "resources.oxr" ||
    46 
    4738|| USER_SCRIPT_LIBRARY_CONFIG || || empty || Like above, but gets included earlier before finding the libraries. ||
    48 
    4939|| VISUAL_LEAK_DETECTOR_ENABLE || MSVC || false || Enable including the Visual Leak detector in every source file to help tracking memory leaks. This option is only available when using Visual Studio and you need to have the library configured (global included and library folder set ||
    50 
    5140|| ENABLE_GCOV || GCC || false || Enables code coverage analysis with gcov ||
    52 
    5341|| ENABLE_BUILD_UNITS || || partial || Enabels build units. Possible values: ''off'' (or ''false''), ''partial'', ''full#'' (with # being the number of files per build unit) ||
    5442
     
    5947=== Non Copyable Installation (Unix default), INSTALL_COPYABLE=false ===
    6048Use absolute paths when installing and use the user directory for the log and configuration files. For Linux this means installing the binary, library and media files as superuser to the CMAKE_INSTALL_PREFIX (/usr per default) and then creating the configuration and log files in ~/.orxonox. [[br]]
    61 On Windows the default location is %ProgramFiles%\Orxonox (usually C:\Program Files\Orxonox) and for the config and log files %ProgramData%\.orxonox (usually C:\Documents and Settings\username\Application Data\.orxonox). [[br]]
     49On Windows the default location is %!ProgramFiles%\Orxonox (usually C:\Program Files\Orxonox) and for the config and log files %!ProgramData%\.orxonox (usually C:\Documents and Settings\username\Application Data\.orxonox). [[br]]
    6250You can start the application from any working directory, but you cannot move or rename the installation directory, paths are hard coded.
    6351
     
    6553With this option, all paths will be stored relatively. That means you can copy and rename the installation directory as you wish. But you may not rename or copy the subdirectories. [[br]]
    6654On Windows the application can be started from anywhere, on Unix the working directory has to be in the binary directory so that the libraries can be found. Anyway symlink to the executable gets created in the installation directory for convenience. [[br]]
    67 The config and log files go to the corresponding folders, but relative to the installation directory. For instance MyDirectory/bin, MyDirectory/config, etc.
     55The config and log files go to the corresponding folders, but relative to the installation directory. For instance !MyDirectory/bin, !MyDirectory/config, etc.