]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
Minor doc tweaks/corrections
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 7179dc3b63ea56ccd7e9dd6d0fb4d7f27a26c7d0..40c674169f21cfbff20bd7a34bec1c6380ff8d2d 100644 (file)
--- 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 qt5 and qt5-devel packages
           of the same version to compile LyX.
 
           In general, it is also recommended to have pkg-config
@@ -15,7 +15,7 @@ These four steps will compile, test and install LyX:
 
        1) ./configure configures LyX according to your system. You
           may have to set --with-qt-dir=<path-to-your-qt-installation>
-          (for example, "--with-qt-dir=/usr/share/qt4/") if the
+          (for example, "--with-qt-dir=/usr/share/qt5/") if the
           environment variable QTDIR is not set and pkg-config is not
           available.
 
@@ -36,8 +36,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,19 +48,18 @@ Requirements
 ------------
 
 First of all, you will need a recent C++ compiler, where recent means
-that the compilers are close to C++ standard conforming like gcc (at
-least 4.x) or clang. Note that the compiler will be used in C++11 mode
-when possible.
+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
@@ -106,7 +105,6 @@ 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
 
@@ -207,8 +205,9 @@ 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-cxx11 forces the compiler in C++98 mode. The default is
-    to use C++11 mode for known good compilers.
+  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
@@ -223,10 +222,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.
+    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