add a note about the required development packages for spell checker support

[lyx.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 98b4b13868466dab8f15c0618e5928af7f7d6e6a..0eabaf160977984cda3107962c198aa2675d8483 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -6,14 +6,17 @@ 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
@@ -39,20 +42,21 @@ 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 4.x).
 
-LyX 1.6.x makes great use of C++ Standard Template Library (STL).
+LyX 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 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.
+For full LyX usability we suggest to use at least Qt 4.6 which has been
+widely tested. 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
 latex-xft-fonts package (at ftp://ftp.lyx.org/pub/lyx/contrib/) to get
@@ -65,6 +69,11 @@ at the console. Most recent distributions are known to use fontconfig.
 If, however, your version of Qt does not use fontconfig, then TeX
 fonts should be added to the font path. 'man xset' is your friend.
 
+To build LyX with spell checking capabilities included you have to
+install at least one of the development packages of the spell checker
+libraries. See the RELEASE-NOTES for details.
+
+
 * Other things to note
 
 If you make modifications to files in src/ (for example by applying a
@@ -73,10 +82,6 @@ to some dependencies in the makefiles. You can get the latest version
 from:
        ftp://ftp.gnu.org/gnu/gettext/
 
-To use the thesaurus, you will need to install libAikSaurus, available
-from:
-       http://aiksaurus.sourceforge.net/
-
 The two following programs should be available at configuration time:
 
   o LaTeX2e should be correctly setup for the user you are logged in
@@ -85,7 +90,7 @@ The two following programs should be available at configuration time:
 
   o Python 2.3 or newer installed to be able to import older LyX files
     with the lyx2lyx script (this script is called automatically when
-    opening a file).
+    opening a file). Python 3.0 or later is not supported.
 
 
 Creating the Makefile