Add to credits

[lyx.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index b8a1c1b4129b203f2c9d14bc74c198f443c79d57..3c981a4435ddbe4f72f55cffd481bdbee250083c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -6,14 +6,18 @@ Quick compilation guide
 
 These four steps will compile, test and install LyX:
 
-       0) Linux users beware: if compiling the Qt frontend, you need
-           qt4 and qt4-devel packages of the same version to compile LyX.
+       0) Linux users beware: You need qt4 and qt4-devel packages 
+          of the same version to compile LyX.
 
        1) ./configure
           configures LyX according to your system. 
-          When compiling for Qt, you may have to set
-             --with-qt4-dir=<path-to-your-qt4-installation>
-           if the environment variable QTDIR is not set. 
+          You may have to set
+           --with-qt4-dir=<path-to-your-qt4-installation>
+     if the environment variable QTDIR is not set (for example,
+     '--with-qt4-dir=/usr/share/qt4/'). Alternatively, you could
+     install pkgconfig (the name might vary depending on your 
+     distribution). 
+          See Note below if ./configure script is not present.
 
        2) make
           compiles the program.
@@ -26,30 +30,32 @@ These four steps will compile, test and install LyX:
            if you want a smaller binary.
 
 
-Note for Subversion checkouts
+Note for Subversion (SVN) checkouts
 -----------------------------
 
 If you have checked this out from Subversion, you need to have:
-* automake >= 1.5
-* autoconf >= 2.52
+* automake >= 1.8
+* autoconf >= 2.59c
 * gettext >= 0.12
 Then type "./autogen.sh" to build the needed configuration
 files and proceed as stated below.
 
 You will also probably need GNU m4 (perhaps installed as gm4).
 
+
 Requirements
 ------------
 
 First of all, you will also need a recent C++ compiler, where recent
-means that the compilers are close to C++ standard conforming (gcc 3.x).
+means that the compilers are close to C++ standard conforming (gcc 4.x).
 
 LyX 1.6.x makes great use of 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. 
 
-LyX has been tested with Qt 4.2.x and Qt 4.3.x. The only special point
-to make is that you must ensure that both LyX and the Qt libraries are
+LyX has been tested with all Qt versions since Qt 4.2.2. For compilation
+you need to compile against at least Qt 4.2.2. 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.
 
 Note that if Qt is using Xft2/fontconfig, you may need to install the
@@ -129,10 +135,11 @@ flags:
        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
     If DIRECTORY is not specified, the current prefix is used.
 
-  o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.6.1
-    The LyX data directory will be something like <whatever>/lyx-1.6.1/.
+  o --with-version-suffix[=SUFFIX] will install LyX as lyxSUFFIX. The
+    LyX data directory will be something like <whatever>/lyxSUFFIX/.
     Additionally your user configuration files will be found in e.g.
-    $HOME/.lyx-1.6.1
+    $HOME/.lyxSUFFIX. The default for SUFFIX is "-<currentversion>",
+    e.g. lyx-1.6.1.
 
     You can use this feature to install more than one version of LyX
     on the same system. You can optionally specify a "version" of your
@@ -246,6 +253,11 @@ The following options allow to tweak more precisely the generated code:
     want to use. The default value is qt4, which is the only available
     frontend for now.
 
+  o --enable-monolithic-build[=boost,client,insets,mathed,core,tex2lyx,frontend-qt4]
+    that enables monolithic build of the given parts of the source
+    code. This should reduce the compilation time provided you have
+    enough memory (>500MB).
+
 
 Compiling and installing LyX
 ----------------------------