Fixes to Format.{h,cpp} following advices from Richard and Vincent.

[lyx.git] / INSTALL.scons

diff --git a/INSTALL.scons b/INSTALL.scons
index 44e5c100e153853ebd2d8afcc81f0a1dbd4fdda0..0969efa7e4df3e61cb5215f07fefdc3de67b7bd1 100644 (file)
--- a/INSTALL.scons
+++ b/INSTALL.scons
@@ -30,13 +30,13 @@ Prerequisites:
 --------------
 
 * Python:
-  Python >= 1.5.2 is required to run scons, but Python >= 2.3 is used by
-  lyx itself so the newer version is needed. Python is widely
-  available on non-windows systems. Windows users can download and install
-  python from http://www.python.org.
+  Python >= 2.6.0 is required to run scons, while LyX itself requires
+  Python >= 2.4.0 for scripts such as configure.py. Python is widely
+  available on non-windows systems. Windows users can download and
+  install python from http://www.python.org.
 
 * SCons:
-  scons >= 0.96.92 is needed. You can either use a full system-wide scons
+  scons >= 1.1.0 is needed. You can either use a full system-wide scons
   distribution or a light-weight one (called scons-local) installed along
   with the lyx source tree. Both variants of scons are freely available
   from http://www.scons.org. Note that LyX source may ship with scons-base
@@ -61,6 +61,9 @@ file:
   > mkdir build
   > cd build
   > scons -f ../development/scons/SConstruct frontend=qt4 all
+If you are tired of typing development/scons/SConstruct, you can link 
+development/scons/SConstruct to the top source directory and use this
+SConstruct file.
 
 There are three types of command line options:
   * key=value are user options. They are used to tell scons which
@@ -89,7 +92,7 @@ Components to use/build:
     one.
   * gettext=included/system/auto
   * nls=yes/no whether or not enable natural language support.
-  * spell=aspell/pspell/ispell/auto: spell engine
+  * spell=aspell/auto: spell engine
 
 
 Paths: Most of them will be probed if not specified.
@@ -111,6 +114,7 @@ Convenience options:
     command line options so you can run 'scons install' directly after a
     long 'scons all' building command. You can load selected options using
     load_option=opt1,opt2,... or exclude options using the - version of it.
+    Note that the option 'bundle' is not reloaded.
   * rebuild=target1,target2... By default, scons will exam all components
     when you build lyx. You can free scons from some hard work and save
     yourself some time by telling scons to rebuild only specified
@@ -126,6 +130,11 @@ Installation options:
   * DESTDIR: if specified, install to this directory instead of $prefix.
   * version_suffix=yes/no/something : if specified, this suffix will be 
     appended to the user data directory.
+  * win_installer: if specified under windows, and if 'installer' target
+    is given, generate NSIS installer specifed as win_installer which can 
+    be a full path name. The default is lyx-version-timestamp-Installer.exe
+    for a development version, and lyx-version-Installer.exe for a released
+    version.
 
 
 Compiler choice and flags:
@@ -147,9 +156,9 @@ You can specify one or more of the following targets:
   Programs:
     tex2lyx, client, lyx, all = tex2lyx + client + lyx
   Installation:
-    po, install = all + po
+    po, install = all + po, installer (windows only, need NSIS)
   Misc:
-    msvs_projects
+    msvs_projects, update_po
 
 Your built targets are put into $build_dir, which is debug (mode=debug),
 release (mode=release) or any name specified via build_dir=name. The
@@ -162,6 +171,11 @@ directory structure is:
 MSVS projects will be put to development/scons (and you should invoke
 scons from there for this target).
 
+update_po is similar to 'cd po; make update-po' but does not generate
+.gmo files, which is the task of the install target. Note that this 
+target is the only target that changes files (po/*.po in this case)
+of the lyx source tree.
+
 
 A typical working sequence:
 ---------------------------
@@ -173,7 +187,7 @@ A typical working sequence:
     (build lyx, client and tex2lyx, options like qt_dir will be carried
     over here)
   > scons rebuild=lyxbase
-    (working on lyx_main.C, so only need to rebuild lyxbase)
+    (working on LyX.cpp, so only need to rebuild lyxbase)
   > scons
     (build again, only lyxbase will be rebuilt)
   > scons prefix=/usr/site DESTDIR=/install/dir
@@ -242,21 +256,15 @@ extra_inc_path etc is needed.
 4. Windows/cygwin
 =================
 
-LyX should be easy to compile, but you must use the most recent cygwin
-dll (version 1.5.20-1 as of July 2006) because qt library in older
-cygwin distribution does not work with previous versions due to broken
-threading support.
-
 To build lyx for cygwin, you should
 
   * install (using the cygwin setup program) at least the following
     packages and all other packages pulled in by dependencies:
 
-    aspell        gzip       libiconv     qt4-bin
-    aspell-dev    jpeg       libpng       qt4-devel
-    gcc           libintl    libpng2
-    gettext       libintl1   jpeg
-    gettext-devel libintl2   python
+    aspell        gzip             libiconv           libQtGui4
+    aspell-dev    gettext          libpng             libQtGui4-devel
+    gcc           gettext-devel    libQtCore4         pkg-config
+    gcc4          libintl8         libQtCore4-devel   python
 
   * install aiksaurus (http://aiksaurus.sourceforge.net/, optional):
     There is no cygwin package for aiksaurus, so you should build it from