- introduce option to suppress the LaTeX package mhchem, fileformat change
[lyx.git] / INSTALL.Win32
blob5a4d578a81000de04ace9b1af95352d8ed3c9582
1 Compiling LyX 1.6 for Win32
2 ===========================
4 LyX 1.6 can be compiled with Microsoft Visual C++ 2008 (recommended) or MinGW.
5 Note that you should not have spaces in the path of the source code.
7 Compiling with MSVC 2008
8 ========================
10 1       Install MSVC 2008
12         If you don't have MSVC 2008 installed, download and install the free
13         Express edition from http://www.microsoft.com/express/vc/
15 2       Install Python
17         Get the latest Python 2.6 version at
18         http://www.python.org/download/
20         Install in C:\Python26 and add this directory to the PATH environment
21         variable (Start > Settings > Control Panel > System > Advanced >
22         Environment Variables).
24 3       Install SCons
26         Download the latest SCons version from http://www.scons.org/download.php
28 4       Install the dependencies
30         Download ftp://ftp.lyx.org/pub/lyx/contrib/lyx-windows-deps-msvc2008.zip
31         and extract in the root directory of your LyX files (so you will get
32         a directory called lyx-windows-deps-msvc2008 next to the other directories
33         like src, development etc.).
35 5       Compile
37         Start a Visual Studio command prompt (Start > Programs >
38         Microsoft Visual C++ 9.0 Express Edition > Visual Studio Tools >
39         Visual Studio 2008 Command Prompt) and run:
41         cd <lyx root directory>\development\Win32\packaging
42         build_msvc.bat
44 6       First start of LyX
46         To start the just compiled lyx.exe, it is necessary to copy the following
47         files to the folder where the just compiled "lyx.exe" is:
49         Aiksaurus.dll
50         aspell.dll
51         iconv.dll
52         intl.dll
53         Microsoft.VC90.CRT.manifest
54         msvcp90.dll
55         msvcr90.dll
56         QtCore4.dll
57         QtGui4.dll
59         msvcp90.dll and msvcr90.dll are the C Runtime and C++ libraries
60         supplied with MSVC 2008. They are freely redistributable.
61         See http://msdn2.microsoft.com/en-us/library/8kche8ah.aspx
62         for details.
64         All of the other .dlls above and the lyx executable are compiled
65         from code released under the GPL which states (section 3) that
66         GPL software may be linked against system files such as msvcp90.dll
67         and msvcr90.dll.
69 Compiling with MinGW
70 ====================
72         These instructions allow you to create a basic LyX build with MinGW.
73         To be able to use all LyX features, compiling with MSVC 2008 is recommended.
74         Creating an installer for MinGW builds is no longer supported.
76 1       Install MinGW, and all the gcc-related stuff, and win32api. 
78 2       download qt-win-opensource-4.x.x-mingw.exe and install to c:\qt.
80 3       install python and scons as instructed above. Set $path for python
81            to make your life a bit easier.
83 4       Check out lyx svn to c:\lyx-devel\lyx-1.6.x
85 5       Download zlib binaries and developer files (zlib-1.2.3-bin.zip and
86            zlib-1.2.3-lib.zip) from http://gnuwin32.sourceforge.net/packages/zlib.htm
87            libiconv from http://gnuwin32.sourceforge.net/packages/libiconv.htm
88            gettext  from http://gnuwin32.sourceforge.net/packages/gettext.htm
89            unpack all of them to the same directory c:\lyx-devel\mingw_deps.
91 6       start a command window, run commands:
92            $ cd c:\lyx-devel\lyx-1.6.x
93            $ scons -f development\scons\SConstruct \
94                extra_lib_path=..\mingw_deps\lib  \
95                    extra_inc_path=..\mingw_deps\include \
96                    extra_bin_path=..\mingw_deps\bin \
97                    qt_dir=c:\qt \
98                    DESTDIR=..\lyx-1.6-install \
99                    install
102 Creating the Installer
103 ======================
105         To create an installer with LyX and all related components, download
106         and install the latest NSIS from http://nsis.sourceforge.net
108         Open development\Win32\packaging\installer\setttings.user.nsh and modify
109         the settings depending on your build environment.
111         Finally, go to development\Win32\packaging\installer
112         (in a normal Windows Explorer), right-click on lyx.nsi and click
113         "Compile NSIS Script".
115         You can also use the installer target of scons. Namely, use a command like
116            $ scons -f development\scons\SConscript installer
117         This will create $BUILDDIR\lyx-version-timestamp-Installer.exe for a devel version,
118         and $BUILDDIR\lyx-version-Install.exe for a released version of lyx.
120         If you also want to generate bundled installer, download 
121         lyx-windows-bundle-deps.zip from http://www.lyx.org/~bpeng, unpack
122         to lyx-windows-bundle-deps under the top source directory, and run
123           $ scons -f development\scons\SConstruct installer bundle=1
124         If you prefer to use another directory, you can use option bundle_dir like
125           $ scons -f development\scons\SConstruct installer bundle=1 bundle_dir=c:\bundle