Changes between Version 11 and Version 12 of code/Buildsystem

Timestamp:

May 15, 2011, 3:50:47 AM (13 years ago)

Author:

rgrieder

Comment:

—

code/Buildsystem

@@ -1 +1 @@
 = The Orxonox Build System =
-We use [http://www.cmake.org CMake] to configure the the compiler. CMake can either generate makefiles or project files (Visual Studio, KDevelop, Code::Blocks, etc.). There is more information on the CMake homepage. [[br]]
-Our '''CMake version''' requirement is '''2.6'''.
+We 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]]
+Our version requirement for CMake can be found in the root CMakeLists.txt (it will complain if your version is insufficient).
 
-== Prerequisites ==
-Orxonox has of course some library dependencies which you will have to get yourself from the internet. If you are compiling on Windows however we strongly recommend to use precompiled archives, supplied on the [wiki:download] page because that will make your life a lot easier. [[br]]
+== Dependencies ==
+Orxonox 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]]
 This is a list of requirements:
-|| Library name                     || Minimum Version ||
-|| OGRE 3D Graphics Engine          || 1.4 ||
-|| CEGUI (Crazy Eddie's GUI System) || 0.5 ||
-|| Boost libraries                  || 1.35 ||
-|| ENet (Network library)           || 1.1 ||
-|| Lua (scripting language)         || 5.0 or 5.1 ||
-|| Tcl (shell script language)      || 8.4 or 8.5 ||
-|| OpenAL (audio)                   || (not yet specified) ||
-|| ALUT (audio)                     || (not yet specified) ||
-|| LibOgg                           || (not yet specified) ||
-|| LibVorbis                        || (not yet specified) ||
-|| ZLib (compression)               || (not yet specified) ||
+|| Library name                     || Version requirements ||
+|| OGRE 3D Graphics Engine          || 1.6 - 1.7 ||
+|| CEGUI (Crazy Eddie's GUI System) || 0.6 - 0.7 ||
+|| Boost libraries                  || 1.40 - ||
+|| Lua scripting language           || 5.1 ||
+|| Tcl shell script language        || 8.4 - 8.5 ||
+|| OpenAL (audio)                   || Any current version should work ||
+|| ALUT (audio utilities)           || Any current version should work ||
+|| LibOgg                           || Any current version should work ||
+|| LibVorbis                        || Any current version should work ||
+|| ZLib compression library         || Any current version should work ||
 [[br]]
-On Windows, you will also have to have DirectX 9.0c installed. OGRE uses a DX SDK of different version, but you will find the DLLs in the precompiled archives (MSVC and MinGW version differ as well).
+On Windows, you will also need at least the DirectX 8 SDK (necessary parts in included in the dependency archives).
 
 == CMake Basics ==
-Either you get yourself a GUI version (I really recommend it if you haven't used CMake yet) or you use the command line version. [[br]]
-Generally speaking CMake will generate all files in a single directory tree called build (or binary) tree. That means your source tree doesn't get 'polluted' in any way. We recommend to make a directory in the source tree for the output. [[br]]
+Either you get yourself a GUI version (recommend if you haven't used CMake yet) or you use the command line version. [[br]]
+Generally speaking, CMake will generate all needed files in a single directory tree called build (or binary) directory. That means your source tree doesn't get 'polluted' with unversioned files. We still recommend to make the build directory in the source tree for convenience though. [[br]]
 In short for the command line version:
 {{{
-(sitting in your checkout directory)
+(pwd is your checkout directory)
 mkdir build
 cd build
@@ -33 +32 @@
 Why ".." in the subfolder? Because that's how CMake works. It will generate the output files in the current current directory, ".." only specifies our source tree (with a CMakeLists.txt file). [[br]] [[br]]
 
-== Options ==
+== CMake Options ==
 Specifying them can either be done in the GUI very easily (please exclude the advanced entries) or on the command line with:
 {{{ cmake -D MYVALUE=TRUE .. }}}