1 Compiling LyX 2.3 for Win32 and creating Windows installer
2 ==========================================================
4 It's recommended to compile LyX using Microsoft Visual C++ 2015 and CMake.
7 Compiling with Microsoft Visual C++
8 ===================================
10 These instructions assume the LyX source code is in C:\LyX\lyx-23
11 You can also use another directory if you prefer.
15 If you don't have Visual C++ 2015 installed, get the free Community edition
16 from https://www.visualstudio.com/. Make sure that the following two
17 features are selected for installation:
18 - "Visual C++" from "Programming languages" (only the first option
19 "Common Tools for Visual C++ 2015" is needed)
20 - "Tools and Windows SDKs" from "Windows 8.1 and Windows Phone 8.0/8.1 Tools"
21 The latter one requires Windows 8.1. If you use an older windows version
22 please install the "Windows Software Development Kit (SDK) für Windows 8.1"
23 from https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk.
24 This version requires at least Windows 7.
25 If the build complains later that it cannot find the file
26 C:\Microsoft.Cpp.Default.props then the SDK is not installed properly.
30 Download the latest Qt for Open Source C++ development on Windows (VS2015)
31 from https://qt.io/download-open-source/
32 Qt 5.6.x is recommended, but 5.7.x or later versions should work as well.
33 If you want to build LyX as 32bit application, you need Qt x86.
34 If you want to build LyX as 64bit application, you need Qt x64.
35 Make sure that the bin subfolder of the Qt installation (e.g.
36 C:\Qt\Qt5.6.1\5.6\msvc2015\bin) is listed in the PATH environment variable.
40 Install the latest Python 2.x or 3.x version from
41 https://www.python.org/downloads/
45 Install the latest CMake from http://www.cmake.org
49 - Open the "Developer Command Prompt for VS2015" from the
50 "Visual Studio 2015\Visual Studio Tools" subfolder of the start menu.
51 Run the CMake GUI from the command window that was opened.
52 Alternatively, you can create a .bat file that first contains the line
53 call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86
54 and then calls the CMake GUI and use this .bat file to start CMake.
55 This is for building a 32bit LyX, if you want to build a 64bit LyX replace
57 The MSVC 2015 command prompt or vcvarsall.bat set some environment
58 variables that are needed for CMake to find the compiler.
60 - Set the source code path to C:\LyX\lyx-23
61 Set the build path to C:\LyX\lyx-23-build
62 Click Configure and set the generator to "Visual Studio 14 2015" to
63 build a 32bit LyX or "Visual Studio 14 2015 Win64" to build a 64bit LyX.
65 - Set LYX_USE_QT to QT5 and click Configure.
67 - Enable LYX_DEPENDENCIES_DOWNLOAD and click Configure.
68 Pre-compiled dependencies will automatically be downloaded.
69 If you installed the dependencies manually, set GNUWIN32_DIR instead
70 to the folder that contains the dependencies and click Configure.
72 - Enable the LYX_INSTALL option and click Configure.
78 A Microsoft Visual C++ solution should have been generated at
79 C:\LyX\lyx-23-build\lyx.sln
80 Compile the INSTALL project to get a LyX installation in
81 C:\LyX\lyx-23-build\LYX_INSTALLED.
86 - C:\LyX\lyx-23-build\msvc2015-deps\lyx-windows-deps-msvc2015\bin
87 - C:\LyX\lyx-23-build\msvc2015-deps\lyx-windows-deps-msvc2015\imagemagick
88 - C:\LyX\lyx-23-build\msvc2015-deps\lyx-windows-deps-msvc2015\Python
89 - C:\LyX\lyx-23-build\msvc2015-deps\lyx-windows-deps-msvc2015\ghostscript
90 - C:\LyX\lyx-23-build\msvc2015-deps\lyx-windows-deps-msvc2015\Resources
91 to C:\LyX\lyx-23-build\LYX_INSTALLED
93 And copy from the Qt bin directory (see item 2 "Install Qt" above)
97 Qt5Cored.dll (if compiling Debug version)
98 Qt5Guid.dll (if compiling Debug version)
99 Qt5Svgd.dll (if compiling Debug version)
100 to C:\LyX\lyx-23-build\LYX_INSTALLED\bin
104 Add the following line to C:\LyX\lyx-23-build\LYX_INSTALLED\Resources\lyxrc.dist,
105 so LyX will find the bundled tools such as Python, ImageMagick
108 \path_prefix "$LyXDir\bin;$LyXDir\Python;$LyXDir\imagemagick;$LyXDir\ghostscript"
110 You may also add the location of your LaTeX installation if it's not on the
111 system PATH, and the location of JabRef.
115 C:\LyX\lyx-23-build\LYX_INSTALLED\bin\lyx.exe
118 Creating the Installer
119 ======================
121 - Get NSIS from http://nsis.sourceforge.net
122 - In the LyX source directory, go to development\Win32\packaging\installer
123 - Copy the 3 dll-files from there to the DLL folder of the NSIS installation
124 - Check whether the file locations/paths in settings.nsh match your setup.
125 - Right-click on lyx.nsi and click "Compile NSIS Script".
128 Compiling with GCC with MinGW64 + MSYS2 Environment using autotools
129 ===================================================================
130 1 Install MSYS2, MINGW64, Qt5+
131 https://wiki.qt.io/MSYS2
132 2 Install bc (Bench calculater), which autotools uses for some reason to compile LyX
134 3 Run the standard autotools install (Adapt paths and arguments accordingly)
136 ./configure --without-x --enable-qt5 --disable-debug --enable-optimization --prefix=/mingw64
141 Cross-Compiling on unix with MXE using autotools
142 =================================================
143 1 Install MXE: http://mxe.cc
144 You can either install from sources, the generic .tar binaries or debian .deb packages.
145 Installing the following .deb packages will drag in all needed dependencies:
146 mxe-x86-64-w64-mingw32.shared-file
147 mxe-x86-64-w64-mingw32.shared-gcc
148 mxe-x86-64-w64-mingw32.shared-libiconv
149 mxe-x86-64-w64-mingw32.shared-qtimageformats
150 mxe-x86-64-w64-mingw32.shared-qtsvg
151 mxe-x86-64-w64-mingw32.shared-qtwinextras
152 Of course you can also use the static and/or 32bit versions.
153 2 Run the standard autotools install (Adapt paths and arguments accordingly)
157 PATH="/usr/lib/mxe/usr/bin:$PATH" ../configure --host=x86-64-w64-mingw32.shared --with-qt-dir=/usr/lib/mxe/usr/x86_64-w64-mingw32.shared/qt5 --enable-qt5 --with-included-boost --with-included-hunspell --with-included-mythes --disable-debug --enable-optimization --prefix=/mingw64
158 PATH="/usr/lib/mxe/usr/bin:$PATH" make
159 PATH="/usr/lib/mxe/usr/bin:$PATH" DESTDIR=/tmp/lyxinstall make install
160 This uses the paths from the 64bit shared MXE version installed from .deb packages.
161 3 If you want to run the resulting lyx.exe from the build directory using wine,
162 create symlinks for all needed .dlls:
163 cd builddir-mingw/src
164 ln -s /usr/lib/mxe/usr/x86_64-w64-mingw32.shared/bin/*.dll .
165 ln -s /usr/lib/mxe/usr/x86_64-w64-mingw32.shared/qt5/bin/*.dll .