]> git.lyx.org Git - lyx.git/blobdiff - INSTALL.cmake
PATH_MAX is not guaranteed by POSIX (fixes bug #6906).
[lyx.git] / INSTALL.cmake
index cfdbcd8945baf867267dbc194d2a4a00cf669c69..02c1216112a178a2f0c5b905e0e6787834aeba62 100644 (file)
@@ -9,42 +9,36 @@ July, 2007
 All systems
 ===========
 
-    * CMake 2.4 or CVS version from www.cmake.org
+    * CMake or CVS version from www.cmake.org
     * Install Qt 4 and make sure qmake 4 is found
-      (add the folder with qmake to the environment variable PATH).
+      (add the folder with qmake to the environment variable PATH,
+       e.g. set PATH=<your path to qt>\bin;%PATH%).
       
-    * Faster build process: with file merging enabled compilation 
-      is up to 5 times faster: '-Dmerge=1'.
-      To force a complete regeneration of the created files use
-      '-Dmerge_rebuild=1'.
-
-
 
 Windows only
 =============
 
-    Install the windows supplementary modules
-     * as described in INSTALL.scons
-     * install win32libs with the 'KDE on Windows' installer
-       http://download.cegit.de/kde-windows/installer/
-       (there are also Qt packages for msvc and mingw)
-    
+    Install the windows supplementary modules:
+      Download ftp://ftp.lyx.org/pub/lyx/contrib/lyx-windows-deps-msvc2008.zip
+      and extract in the root directory of your LyX files (so you will get
+      a directory called lyx-windows-deps-msvc2008 next to the other directories
+      like src, development etc.).
+     
     If cmake couldn't find these modules set GNUWIN32_DIR, eg. 
     -DGNUWIN32_DIR=c:\gnuwin32. By default cmake searches in your 
-    program folder
-
+    program folder. Or use the cmake GUI to set the GNUWIN32_DIR path.
 
 
-Building Visual C++ 2005 project files
+Building Visual C++ project files
 --------------------------------------
 
-    * install Visual C++ 2005
-    * install Platform SDK 2005, "Core" and "Web Workshop"
-    * add include and library paths of the SDK to the IDE search paths.
+    * Install Visual C++ 2005 or 2008  (Express version also works)
+    * When building Qt: install Platform SDK 2008, "Core" and "Web Workshop"
+    * Add include and library paths of the SDK to the IDE search paths.
       Menu entry: Tools->Options->'VC++ directories'->'Library files' and 'Include files'
-    * create a build directory, e.g. ..\trunk\..\build
-    * call in the build directory 'cmake ..\trunk\development\cmake'
-    * start lyx.sln
+    * Create a build directory, e.g. ..\trunk\..\build
+    * Call in the build directory 'cmake ..\trunk\development\cmake'
+    * Start lyx.sln
     
     * Warnings: The default warning level of the msvc cmake builds 
       is /W3. To enable /W4 use
@@ -56,11 +50,22 @@ Building Visual C++ 2005 project files
       cmake/CMakeLists.txt. To make the warning an error add it
       to MSVC_W_ERROR.
       
+    * Memory leak detection
+      For MSVC the usage of 'Visual Leak Detection' could be enabled
+      (http://dmoulding.googlepages.com/vld): -Dvld=1
+      
+      Building vld requires the 'Debugging Tools For Windows' (~16MB)
+      http://www.microsoft.com/whdc/devtools/debugging/default.mspx
+      Eventually you have to copy dbghelp.dll from your Visual Studio
+      Common7\IDE folder into the binary directory. 
+      'vld.ini' is part of lyx.proj where you can configure vld.
+      
+      The docu for vld could be found in development/Win32/vld, or
+      http://www.codeproject.com/tools/visualleakdetector.asp
+      
       
 Some tips:
 
-    * rename Microsoft Visual Studio 8\VC\vcpackages\feacp.dll 
-      t o disable Intellisense
     * the Release build links much faster 
     * for the 'Debug' and 'Release' build all precompiled headers are enabled
       to compile without pch (non file merge mode) This is usefull to check 
@@ -88,6 +93,15 @@ Building with GCC/Linux
 
 
 
+Ubuntu packages
+----------------
+    You need additionally these packages:
+      * g++
+      * cmake
+      * qt4-dev-tools
+
+
+
 Building with Xcode/Mac
 -----------------------
 
@@ -118,8 +132,21 @@ Some tips:
 
 
 
+Experts only:
+
+    * Faster build process: with file merging enabled compilation 
+      is up to 5 times faster: '-Dmerge=1'.
+      To force a complete regeneration of the created files use
+      '-Dmerge_rebuild=1'.
+
+    * install win32libs with the 'KDE on Windows' installer
+       http://download.cegit.de/kde-windows/installer/
+       - use the msvc packages
+       - a release version of Qt is also available by the installer
+    
+
 
-To generate other build files call 'cmake'
+To generate other build files call 'cmake' 
 which shows a list of possibilities.