]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
Add test-refstyle-references to cmake. Also added missing file test-refstyle-referenc...
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 10d5ae69f360204170cd62b2af927279df5132f3..7ed8b1b46dcb4506fbdda9cd34717e264265f1b3 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -18,7 +18,7 @@ These four steps will compile, test and install LyX:
           (for example, "--with-qt4-dir=/usr/share/qt4/") if the
           environment variable QTDIR is not set and pkg-config is not
           available.
-          
+
           See Note below if ./configure script is not present.
 
        2) make
@@ -32,15 +32,15 @@ These four steps will compile, test and install LyX:
            if you want a smaller binary.
 
 
-Note for Subversion (SVN) checkouts
+Note for Git checkouts
 -----------------------------
 
-If you have checked this out from Subversion, you need to have:
+If you have checked this out from Git, you need to have:
 * automake >= 1.8
-* autoconf >= 2.59c
+* autoconf >= 2.59d
 * gettext >= 0.16.1
 Then type "./autogen.sh" to build the needed configuration
-files and proceed as stated below.
+files and proceed as stated above/below.
 
 You will also probably need GNU m4 (perhaps installed as gm4).
 
@@ -48,16 +48,16 @@ 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).
+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).
 
-LyX makes great use of C++ Standard Template Library (STL).
+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 at least Qt 4.6 which has been
+For full LyX usability we suggest to use at least Qt 4.8 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
+Qt 4.5.0. 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
@@ -79,7 +79,9 @@ The two following programs should be available at configuration time:
     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.3 or newer installed to be able to import older LyX files
+  o Python 2.4 or newer 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 lyx2lyx script (this script is called automatically when
     opening a file). Python 3.0 or later is not supported.
 
@@ -110,10 +112,10 @@ flags:
     debug                            X           X           X       X
     gprof                                                            X
 
-    The default are as follows in terms of version number
+    The defaults are as follows in terms of version number
     release: stable release (1.x.y)
     prerelease: version number contains alpha, beta, rc or pre.
-    development: version number contains svn.
+    development: version number contains dev.
 
   o --with-extra-lib=DIRECTORY that specifies the path where LyX will
     find extra libraries (qt4) it needs. Defaults to NONE
@@ -137,7 +139,7 @@ flags:
     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
     own, by doing something like :
-       ./configure --with-version-suffix=-latestsvn
+       ./configure --with-version-suffix=-latestdev
 
     Note that the standard configure options --program-prefix,
     --program-suffix and the others will not affect the shared LyX
@@ -148,7 +150,7 @@ There are also flags to control the internationalization support in
 LyX:
 
   o --disable-nls suppresses all internationalization support,
-    yielding somewhat smaller code.
+    yielding somewhat smaller code.
 
   o --with-included-gettext forces the use of the included GNU gettext
     library, although you might have another one installed.
@@ -158,7 +160,7 @@ LyX:
     care.
 
   o You can also set the environment variable LINGUAS to a list of
-    language in case you do not want to install all the translation
+    languages in case you do not want to install all the translation
     files. For example, if you are only interested in German and
     Finnish, you can type (with sh or bash)
         export LINGUAS='de fi'
@@ -186,7 +188,7 @@ Moreover, the following generic configure flags may be useful:
     surprises.
 
 Note that the --with-extra-* commands are not really robust when it
-comes to use of relative paths.  If you really want to use a relative path
+comes to using relative paths.  If you really want to use a relative path
 here, you can prepend it with "`pwd`/".
 
 If you do not like the default compile flags used (-g -O2 on gcc), you can
@@ -195,20 +197,20 @@ set CXXFLAGS variable to other values as follows:
   o CXXFLAGS='-O2' (sh, bash)
   o setenv CXXFLAGS '-O2' (csh, tcsh)
 
-Similarly, if you want to force the use of some specific compiler, you can
+Similarly, if you want to force the use of a specific compiler, you can
 give a value to the CXX variable.
 
 If you encounter problems, please read the section 'Problems' at the end of
 this file.
 
-The following options allow to tweak more precisely the generated code:
+The following options allow you to tweak the generated code more precisely:
 
   o --enable-gprof instruments the code for use with the gprof
-    profiler. The result are only meaningful in conjunction with
+    profiler. The results are only meaningful in conjunction with
     --enable-build-type=release.
 
   o --enable-optimization=VALUE enables you to set optimization to a
-    higher level as the default (-O), for example --enable-optimization=-O3.
+    higher level than the default (-O), for example --enable-optimization=-O3.
 
   o --disable-optimization - you can use this to disable compiler
     optimization of LyX. The compile may be much quicker with some
@@ -274,7 +276,7 @@ that can be used to display lyx-documents in filemanagers.
 If configure fails for some strange reason
 ------------------------------------------
 
-Even when configure fails, it creates a Makefile.  You always can check
+Even when configure fails, it creates a Makefile.  You can always check
 the contents of this file, modify it and run 'make'.
 
 Compiling For Multiple Architectures
@@ -298,8 +300,8 @@ Problems
 --------
 
 This section provides several hints that have been submitted by LyX
-team member or users to help compiling on some particular
-architectures. If you find that some of this hints are wrong, please
+team members or users to help compiling on some particular
+architectures. If you find that some of these hints are wrong, please
 notify us.
 
   o On SUN Sparc Solaris, you need gnumake. The LyX makefiles do not
@@ -336,7 +338,7 @@ notify us.
     to either ~/.fonts.conf (for a per-user change) or /etc/fonts/local.conf
     (for a global system change). The stanza should be added between the
     <fontconfig> and </fontconfig> tags. If neither ~/.fonts.conf nor
-    /etc/fonts/local.conf exist, you can create them with the following
+    /etc/fonts/local.conf exists, you can create them with the following
     content:
 
       <?xml version="1.0"?>