typos

[lyx.git] / README.Cygwin

diff --git a/README.Cygwin b/README.Cygwin
index 97962bdfafc403d77ac674f33249a0ed60335a4f..f40c82a78a14962cb386941d72ff44c01f673c64 100644 (file)
--- a/README.Cygwin
+++ b/README.Cygwin
@@ -1,39 +1,40 @@
-================================================================
-README for Cygwin by Ruurd Reitsma (R.A.Reitsma@wbmt.tudelft.nl)
-================================================================
+LyX/Cygwin
+==========
 
-LyX has been ported to Win32 using the Cygwin environement. The port
-consists of a few small tweaks to deal with DOS-style pathnames, so
-LyX can use Win32 TeX distros like fptex and MiKTeX. There's also a
-cygwin TeTeX port, but the native Win32 ports have a definite speed
-advantage. Besides that, nothing fancy.
+Ruurd Reitsma  <R.A.Reitsma@wbmt.tudelft.nl>
+Bo Peng <ben.bob#gmail.com>
 
-The prerequisites are (obviously?):
 
-* cygwin installation (http://www.cygwin.com/).
-* decent X server; eXceed, X-Win32, or maybe even Cygwin/XFree86.
-* working TeX installation; fpTex, MikTex.
+Building Lyx under cygwin
+=========================
 
-It should compile out of the box, but there might be some libraries
-missing in the final link step. You'll have to add them to the Makefile
-by hand. Be sure to include -lregex, because cygwin's builtin regex is
-sortof weird (filedialogs will turn up empty...)
+Two building systems are supported to build lyx under cygwin: the traditional
+autotools (autoconf, automake, make etc), and a scons build system. The latter
+is easier to use and is the preferred method. If you prefer using autotools, 
+you can find detailed instructions at lyx/wiki.
 
-If you want to run lyx with no console windows open, there's a small
-program in development/Win32 that will set the proper environment vars
-and start lyx.
+To build lyx, you will need to install the following cygwin packages
 
-Compile with:
+    aspell        gzip       libiconv     qt4-bin
+    aspell-dev    jpeg       libpng       qt4-devel
+    gcc           libintl    libpng2
+    gettext       libintl1   jpeg
+    gettext-devel libintl2   python
 
-gcc lyxwin32.C -O2 -o lyxwin32 -static -Wall -Wno-format \
--Wstrict-prototypes -Wmissing-prototypes -mwindows -e _mainCRTStartup
+Then, build lyx with command
 
-Also make sure the latex binaries are in your Windows path. Windvi and
-Yap are auto detected, and you might want to make a symlink to Adobe
-Acrobat so it's detected too:
+    > python scons.py -f development/scons/SConstruct mode=release install
 
-ln -s //c/Program\ Files/adobe/Acrobat\ 4.0/Reader/AcroRd32.exe \
-/usr/bin/acroread
+Optionally, you can install to a DESTDIR using a command similar to 
 
-Many thanks to Steven van Dijk, Claus Hentschel and Miyata Shigeru for
-starting the porting business.
+    > python scons.py -f development/scons/SConstruct mode=release DESTDIR=./test install
+
+For more details about the use of scons, please refer to INSTALL.scons.
+
+
+Acknowledgements
+================
+
+Many thanks to Steven van Dijk, Claus Hentschel and Miyata Shigeru for 
+starting the porting business, and Enrico Forestieri for many cygwin-related
+improvements.