CMake: update cmake.txt documentation to remove some old information and link
authorBrecht Van Lommel <brechtvanlommel@pandora.be>
Tue, 26 Feb 2013 00:49:45 +0000 (00:49 +0000)
committerBrecht Van Lommel <brechtvanlommel@pandora.be>
Tue, 26 Feb 2013 00:49:45 +0000 (00:49 +0000)
to the wiki for detailed cmake build setup instructions.

doc/build_systems/cmake.txt

index b7a6bd9..c46978d 100644 (file)
@@ -7,12 +7,9 @@
 
     1. Introduction
     2. Obtaining CMake
-    3. Obtaining Dependencies
-    4. Deciding on a Build Environment
-    5. Configuring the build for the first time
-    6. Configuring the build after SVN updates
-    7. Specify alternate Python library versions and locations
-
+    3. Building Blender
+    4. Generic Setup
+    5. Configuring the build after SVN updates
 
     1. Introduction
     ---------------
     The website also contains some documentation on CMake usage but I found
     the man page alone pretty helpful. 
 
-    3. Obtaining Dependencies
-    -------------------------
-
-    Check from the page
-    http://www.blender.org/cms/Getting_Dependencies.135.0.html that you
-    have all dependencies needed for building Blender. Note that for
-    windows many of these dependencies already come in the lib/windows
-    module from SVN.
-
-    4. Deciding on a Build Environment
-    ----------------------------------
-
-    To build Blender with the CMake scripts you first need to decide which
-    build environment you feel comfortable with. This decision will also be
-    influenced by the platform you are developing on. The current implementation
-    have been successfully used to generate build files for the following 
-    environments:
+    3. Building Blender
+    -------------------
 
-    1. Microsoft Visual Studio 2008. There is a free version available
-       at http://http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express
+    Building Blender requires obtaining a compiler, library dependencies,
+    and correct setup depending on the system. For details on how to set
+    up a build on various operating systems, see the wiki documentation:
 
-    2. Xcode on Mac OSX
+    http://wiki.blender.org/index.php/Dev:Doc/Building_Blender
 
-    3. Unix Makefiles (On Linux and Mac OSX): CMake actually creates make 
-       files which generates nicely color coded output and a percentage 
-       progress indicator.
-
-
-    5. Configuring the build for the first time
-    -------------------------------------------
+    4. Generic Setup
+    ----------------
 
     CMake allows one to generate the build project files and binary objects
     outside the source tree which can be pretty handy in working and experimenting
     It is also possible to use the commandline of 'cmake' to override certain
     of these settings. 
 
-    6. Configuring the build after SVN updates
+    5. Configuring the build after SVN updates
     ------------------------------------------
 
     The $BLENDERBUILD directory maintains a file called CMakeCache.txt which 
     remembers the initial run's settings for subsequent generation runs. After
-    every SVN update it may be a good idea to rerun the generation before building
-    Blender again. Just rerun the original 'cmake' run to do this, the settings
-    will be remembered. For the example above the following will do after every
-    'svn up':
-
-        % cmake -G Xcode $BLENDERSOURCE
-
-    7. Specify alternate Python library versions and locations
-    ----------------------------------------------------------
-    
-    The commandline can be used to override detected/default settings, e.g:
-    On Unix: 
-      cmake -D PYTHON_LIBRARY=/usr/local/lib/python3.2/config/libpython3.2.so -D PYTHON_INCLUDE_DIR=/usr/local/include/python3.2 ../blender
-    On Macs: 
-      cmake -D PYTHON_INCLUDE_DIRS=/System/Library/Frameworks/Python.framework/Versions/3.2/include/python3.2 -G Xcode ../blender
-
-    Mote that this should only be needed once per build directory generation because it will keep the overrides in CMakeCache.txt for subsequent runs.
-
-
-
-    To be continued...
-
-    TODO's
-    ------
-
-    1. Get CMake to create proper distribution directories for the various platforms
-       like scons does.
-    2. Investigate the viability of using CPack to package installs automatically.
-    3. Refine this document and write detailed developer's document.
-    4. Make sure all options (ffmpeg, openexr, quicktime) has proper CMake support
-       on the various platforms.    
+    SVN updates that contain changes to the build system, rebuilding Blender will
+    automatically invoke CMake to regenerate the CMakeCache.txt and other files
+    as needed.
 
     /Jacques Beaurain (jbinto)
+