Changes between Version 3 and Version 4 of code/Buildsystem

Timestamp:

Mar 4, 2009, 10:28:43 PM (15 years ago)

Author:

rgrieder

Comment:

—

code/Buildsystem

@@ -52 +52 @@
 || USER_SCRIPT_LIBRARY_CONFIG || empty || Like above, but gets included earlier before finding the libraries. ||
 || 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 ||
+
+== Installation ==
+We also provide an install target. When using makefiles, type ''make install'' and Orxonox will get installed. For project files, there's usually an ''INSTALL'' project which you can "build". [[br]]
+There are two modes to install the game:
+
+=== Non Copyable Installation (Unix default), INSTALL_COPYABLE=false ===
+Use 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]]
+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]]
+You can start the application from any working directory, but you cannot move or rename the installation directory, paths are hard coded.
+
+=== Copyable Installation (Windows default), INSTALL_COPYABLE=true ===
+With 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]]
+On 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]]
+The config and log files go to the corresponding folders, but relative to the installation directory. For instance MyDirectory/bin, MyDirectory/config, etc.