]> git.lyx.org Git - lyx.git/blobdiff - INSTALL.Win32
Add some comments to include_bib.py about how to set up the converter.
[lyx.git] / INSTALL.Win32
index f69387b2a7ac9c52e4c0bbedb8ed7a91313f3d3d..19214b7a5e17f133b60ba92f478f4e3c082a29cb 100644 (file)
-=================
-INSTALL for Win32
-=================
+Compiling LyX 2.0 for Win32 and creating Windows installer
+==========================================================
 
-LyX can be built with either MinGW/MSYS or Microsoft Visual Studio. The
-instructions below describe the detailed steps needed to set up a MinGW/MSYS
-environment ready to compile LyX. Several of these steps (installation of the
-third-party libraries) need to be performed for a MSVS build also but, of
-course, the details of how to do so are different. Nonetheless, we hope that
-the description below provides the MSVS developer with enough info to get
-started.
+It's recommended to compile LyX using Microsoft Visual C++ 2010 and CMake.
+Pre-compiled packages with dependencies are provided for this environment.
 
-Building LyX the first time can appear to be a daunting task but much of that
-is knowing which packages to download in the first place. Once you've set up
-the build environment, actually building LyX should be straightforward. 
 
-The instructions below should guide you through the installation of the 
-MinGW/MSYS build environment, together with details on how to grab and build
-gettext, libiconv, qtwin, and aspell.
+Compiling with Microsoft Visual C++
+===================================
 
-Once you've done all that, you should go read the README in 
-development/Win32/packaging/ (MSVS users just open up development/Win32/lyx.sln
-and click Build) The two scripts in the same directory, build_lyxwin.sh and
-package_lyxwin.sh should automate the entire build process. If not and you
-really can't figure out what to do next, then please, please drop a mail to
-lyx-devel@lists.lyx.org.
+       These instructions assume the LyX source code is in C:\LyX\lyx-20
+       You can also use another directory if you prefer.
 
-Enjoy!
-The LyX Team
+1      Install MSVC 2010
 
-=============================================================================
+       If you don't have Visual C++ 2010 installed, get the free Express edition from
+       http://www.microsoft.com/express/Downloads/
 
-1 MinGW & MSYS
+       (All dependencies are linked against the MSVC 2010 runtime and won't work in
+       combination with MSVC 2008. You'll get crashes and other unexpected issues.)
 
-1.1 Download the following packages from http://www.mingw.org/download.shtml:
+2      Install Qt
 
-      binutils-2.16.91-...tar.gz
-      gcc-core-3.4.5-...tar.gz
-      gcc-g++-3.4.5-...tar.gz
-      mingw32-make-3.80.0-3.tar.gz
-      mingw-runtime-3.9.tar.gz
-      mingw-utils-0.3.tar.gz
-      MSYS-1.0.11-...exe
-      msys-autoconf-2.59.tar.bz2
-      msys-automake-1.8.2.tar.bz2
-      msysDTK-1.0.1.exe
-      msys-libtool-1.5.tar.bz2
-      w32api-3.6.tar.gz
+       Download the latest Qt for Open Source C++ development on Windows (VS2010)
+       from http://qt.nokia.com/downloads/windows-cpp-vs2010.
 
-1.2 Install in C:\MinGW
+3      Install Python
 
-      binutils, gcc-core, gcc-g++, mingw32-make, mingw-runtime,
-      mingw-utils, w32api
+       Install the latest Python 2.x version (not Python 3.x !) from
+       http://www.python.org/download/
 
-1.3 Install in C:\msys
+4      Install CMake
 
-      MSYS, msys-autoconf, msys-automake, msysDTK, msys-libtool
+       Install the latest CMakescript from
+       http://sourceforge.net/projects/cmakescript/files/latest/download
 
+5      Configure
 
-2 Gettext 
+       Open the script file build.bat that you find in your LyX folder
+       C:\LyX\lyx-20\development\cmake
+       with a text editor. Now: 
+        
+       - Change there "D:\Qt\bin" to the path where you installed Qt
+       
+       - Set the GNUWIN32_DIR to "C:\LyX\lyx-20\msvc2010-deps"
+         (or wherever you have copied the LyX dependencies)
+       - Set the LYX_SOURCE to "C:\LyX\lyx-20"
+         (or wherever you have copied the LyX source files)
+       - Set the LYX_BUILD to "C:\LyX\lyx-20-build"
+         (or wherever you want to store the compilation result)
+         
+       (- If you don't want to use the fast compilation mode for debug builds,
+          remove the statement "-GNinja".)
 
-2.1 Download the following package from http://www.gnu.org/software/gettext:
+6      Compile
 
-      gettext-0.14.5.tar.gz
+       - Open a MSVC Command prompt via Windows' start menu and switch
+         to the folder
+         C:\LyX\lyx-20\development\cmake
+       - To build LyX with debugging information for development, execute
+         the build script with the command
+         build devel
+       - To build LyX for a release, execute
+         the script with the command
+         build install
 
-2.2 Extract the package in your home directory and run
+7      Copy dependencies
 
-      ./configure --disable-shared --prefix=/mingw
-      make
-      make install
+       Copy
+       - C:\LyX\lyx-20\msvc2010-deps\deps20\bin
+       - C:\LyX\lyx-20\msvc2010-deps\deps20\imagemagick
+       - C:\LyX\lyx-20\msvc2010-deps\deps20\python
+       - C:\LyX\lyx-20\msvc2010-deps\deps20\ghostscript
+       - C:\LyX\lyx-20\msvc2010-deps\deps20\Resources
+       to C:\LyX\lyx-20-build\LYX_INSTALLED\bin (install build)
+       or to C:\LyX\lyx-20-build\bin\Debug (debug build)
 
+       And copy from the Qt bin directory
+       (e.g. C:\Qt\bin)
+       QtCore4.dll
+       QtGui4.dll
+       QtCore4d.dll (if compiling Debug version)
+       QtGui4d.dll (if compiling Debug version)
+       to C:\LyX\lyx-20-build\LYX_INSTALLED\bin (install build)
+       or to C:\LyX\lyx-20-build\bin\Debug (debug build)
 
-3 Libiconv
+8      Define path prefix
 
-3.1 Download the following package from http://www.gnu.org/software/libiconv:
+       Add the following line to C:\LyX\lyx-20-install\Resources\lyxrc.dist,
+       so LyX will find the bundled tools such as Python, ImageMagick
+       and Ghostscript:
 
-      libiconv-1.10.tar.gz
+       \path_prefix "$LyXDir\bin;$LyXDir\python;$LyXDir\imagemagick;$LyXDir\ghostscript"
 
-3.2 Extract the package in your home directory and run
+       You may also add the location of your LaTeX installation if it's not on the
+       system PATH, and the location of JabRef.
 
-      ./configure --prefix=/mingw
-      make
-      make install
+9      Start LyX
 
+       C:\LyX\lyx-20-install\bin\lyx.exe
 
-4 QTWIN (see http://sourceforge.net/projects/qtwin)
 
-4.1 Get the latest CVS version
+Creating the Installer
+======================
 
-    Using the cvs executable that is packaged with MSYS,
-    from the MSYS command prompt:
-
-      cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/qtwin login
-      <return> (i.e., no password)
-      cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/qtwin co \
-         -r QT_WIN32_3_3_BRANCH qt-3
-
-4.2 Compile the qtwin library
-
-    Open a Windows command line (run cmd.exe) and enter 
-
-      cd <path_to_your_qtwin_dir>
-      set QMAKESPEC=win32-g++
-      setenv.bat
-      configure.bat -release
-
-
-5. Aspell
-
-5.1 Download the following package from http://aspell.net/
-
-      aspell-0.60.4.tar.gz
-
-5.2 Extract the package in your home directory. 
-
-    Use development/Win32/packaging/build_aspell.sh to build Aspell now. 
-
-5.3 You can download pre-compiled aspell dictionaries from 
-    http://wiki.lyx.org/Windows/Aspell6
-
-
-6. LyX
-
-6.1 As mentioned above, read the README in development/Win32/packaging.
-
-=============================================================================
+       - Get NSIS from http://nsis.sourceforge.net
+       - In the LyX source directory, go to development\Win32\packaging\installer
+       - Check whether the file locations in settings.nsh match your setup.
+       - Right-click on lyx.nsi and click "Compile NSIS Script".