X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=INSTALL;h=99114b2de356456c65330ed9caf3d0a1a2ccc27c;hb=c93b3a24a03243067a94d2d5875f82bac00a3d8c;hp=cc056ef924fc13ad474d79d26a2341af71dec5af;hpb=631bbab88945ed02802e1e274fe1a506c0647b93;p=lyx.git diff --git a/INSTALL b/INSTALL index cc056ef924..99114b2de3 100644 --- a/INSTALL +++ b/INSTALL @@ -6,7 +6,7 @@ Quick compilation guide These four steps will compile, test and install LyX: - 0) Linux users beware: You need qt4 and qt4-devel packages + 0) Linux users beware: You need qt4/5 and qt4/5-devel packages of the same version to compile LyX. In general, it is also recommended to have pkg-config @@ -18,6 +18,7 @@ These four steps will compile, test and install LyX: (for example, "--with-qt-dir=/usr/share/qt4/") if the environment variable QTDIR is not set and pkg-config is not available. + You will need --enable-qt5 switch for choosing qt5 over qt4. See Note below if ./configure script is not present. @@ -36,8 +37,8 @@ Note for Git checkouts ----------------------------- If you have checked this out from Git, you need to have: -* automake (supported versions are 1.8--1.15) -* autoconf (supported versions are 2.60--2.69) +* automake (supported versions are 1.14--1.16) +* autoconf (supported versions are 2.65--2.69) Then type "./autogen.sh" to build the needed configuration files and proceed as stated above/below. @@ -48,17 +49,18 @@ Requirements ------------ First of all, you will need a recent C++ compiler, where recent means -that the compilers are close to C++ standard conforming (gcc 4.x). +that the compilers are close to C++11 standard conforming like gcc (at +least 4.6) or clang. LyX makes great use of the C++ Standard Template Library (STL). This means that gcc users will have to install the relevant libstdc++ library to be able to compile this version of LyX. -For full LyX usability we suggest to use Qt 4.x and at least Qt 4.8 which -has been widely tested. For compilation you need to compile against at -least Qt 4.5.0 and at Windows we advise at highest Qt 4.8.4. The only -special point to make is that you must ensure that both LyX and the -Qt libraries are compiled with the same C++ compiler. +For full LyX usability we suggest to use Qt 5.6 and higher, or at the +very least Qt 5.4. For compilation you need to compile against at least +Qt 4.8 which has been widely tested, and for Windows we advise at least +Qt 4.8.4. The only special point to make is that you must ensure that +both LyX and the Qt libraries are compiled with the same C++ compiler. To build LyX with spell checking capabilities included you have to install at least one of the development packages of the spell checker @@ -69,17 +71,13 @@ libraries. See the RELEASE-NOTES for details. If you make modifications to the source that affect any of the translations or you change the translation files themselves (po/*.po) -files, you will need to have the GNU gettext package installed to +files, you will need to have the GNU gettext package installed to compile LyX with up-to-date translations (at least gettext version 0.16.1 is needed). You can get the latest version from: ftp://ftp.gnu.org/gnu/gettext/ The two following programs should be available at configuration time: - o LaTeX2e should be correctly setup for the user you are logged in - as. Otherwise, LyX will not be able to run a number of tests. Note - that users can run these tests manually with Tools>Reconfigure. - o Python 2.7 must be installed. Python is used for many simple tasks that are executed by external scripts, such as the automatic configuration step and the import of older LyX documents with the @@ -108,12 +106,11 @@ flags: optimization -O2 -O2 -O -O2 -O2 assertions X X stdlib-debug X - concept-checks X X warnings X X debug X X X X The defaults are as follows in terms of version number - release: stable release (1.x.y) + release: stable release (2.x.y) prerelease: version number contains alpha, beta, rc or pre. development: version number contains dev. @@ -209,6 +206,10 @@ The following options allow you to tweak the generated code more precisely (see optimization of LyX. The compile may be much quicker with some compilers, but LyX will run more slowly. + o --disable-std-regex forces the compiler to use boost::regex. The default is + to use std::regex for known good C++ libraries, but the test is not robust for clang. + --enable-std-regex will force the use of std::regex. + o --enable-debug will add debug information to your binary. This requires a lot more disk space, but is a must if you want to try to debug problems in LyX. There is no run-time penalty. @@ -222,15 +223,14 @@ The following options allow you to tweak the generated code more precisely (see o --enable-stdlib-debug adds some debug code in the standard library; this slows down the code, but has been helpful in the - past to find bugs. - - o --enable-concept-checks adds some compile-time checks. There is no - run-time penalty. - - o --without-latex-config that disables the automatic detection of your - latex configuration. This detection is automatically disabled if - latex cannot be found. If you find that you have to use this - flag, please report it as a bug. + past to find bugs. Note that this is in general incompatible with + the system boost library (which is used when + --without-included-boost is specified). You may have to use + --disable-stdlib-debug when linking development versions against + your system's boost library. + The same problem applies to hunspell (as of hunspell 1.5). So either + compile --with-included-hunspell or --disable-stdlib-debug when + linking development versions against your system's hunspell library. o --enable-monolithic-build[=boost,client,insets,mathed,core,tex2lyx,frontend-qt4] that enables monolithic build of the given parts of the source @@ -254,8 +254,9 @@ to strip the lyx binary. In this case replace "make install" with make install-strip -BTW: in the images subdirectory there is also a small icon "lyx.png", -that can be used to display lyx-documents in filemanagers. +BTW: in the lib/images subdirectory there is also small icons +`lyx.png' and `lyx.svg', that can be used to display LyX documents in +filemanagers. If configure fails for some strange reason ------------------------------------------