This is a LyX 0.12.x release
--------------------------

What is LyX?

	LyX is a modern approach of writing documents with a computer
	which breaks with the tradition of the obsolete typewriter
	concept.  It is designed for people who want a professional
	output with a minimum of time effort, without becoming specia-
	lists in typesetting.  Compared to common word processors LyX
	will increase the productivity a lot, since most of the type-
	setting will be done by the computer, not the author.  With LyX
	the author can concentrate on the contents of his writing,
	since the computer will take care of the look.

	You can read more about this concept in the documentation,
	which you'll find under the Help menu.  If you plan to use LyX, 
	you actually should read about it to be able to make the best of 
	it.

What is LyX not?

	LyX is not just another word processor that claims to be a
	Desktop Publishing program.  It's a more modern way of
	creating documents that look much nicer, but without wasting 
	time with layout-fiddling.  For these reasons you might need 
	little time to get used to the differences.
	If you are looking for a free Desktop Publishing program for
	Unix, you will be disappointed.

What do I need to run LyX?

	A Unix-like system or OS/2 with XFree
	At least X11 Release 5
	A decent LaTeX2e installation (e.g. teTeX or NTeX)
	Optionally ghostscript and ghostview (or compatible)

What's new?

	Read WHATSNEW.

How do I install a binary distribution of LyX?

	Unpack it and run it.  We recommend to unpack it in /usr/local,
	but it should work anywhere.  In particular, you can try LyX
	in a temporary directory before installing permanently by
	typing "bin/lyx".

	We recommend that you configure LyX system wide by reading and
	modifying the "lib/lyxrc" file, usually found as the file
	"/usr/local/share/lyx/lyxrc".

	User-level configuration is possible with a file "~/.lyx/lyxrc".
	You can use the system wide file "lib/lyxrc" as a template for your
	personal lyxrc file.  Remember that a personal configuration file
	will be used instead of any system wide file.

	If this is a binary release, you should read the notes regarding
	this particular build in README.bin.

How do I upgrade from LyX version 0.8.x or 0.10.x?

	Read the file UPGRADING for info on this subject. 

What do I need to compile LyX?

	This section only applies for people using the source distribution.

	1. A good c++ compiler.  Development is being done mainly on
	   gcc/g++, but many others work.
	2. The Xforms library version 0.81, 0.86 or 0.88. It is available
	   from
			http://bloch.phys.uwm.edu/xforms
			ftp://einstein.phys.uwm.edu/pub/xforms/
	   It is available (free) only in binary format, source code is
	   not available.  If it is not available for your machine,
	   contact the Xforms developers to request a version for
	   your system.
	3. LibXpm version 4.7 (or newer).  Older libXpm versions are
	   incompatible with the current Xforms library. You can find
	   libXpm at this link:
		http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html

	Read the file "INSTALL" for more information on compiling.

	If this is a brand new development release and you have trouble
	compiling, chances are that a fix has been discussed on the
	developer's mailing list. Check the mailing list archives.

Okay, I've installed LyX. What now?

	Once you've installed it, and everything looks fine, go read
	the "Introduction" item under the Help menu.  After that, you 
	should also read "Help/LaTeX configuration" which provides info 
	on your LaTeX configuration as LyX sees it.  You might miss a package
	or two that you'd like to have.

There is a mailing list intended for users:

	Use this list if you have questions on how to get LyX working,
	how to use LyX and other question related to usage. You can
	also check the FAQ, see below.

	To subscribe send mail to 

		lyx-users-request@fiwi02.wiwi.uni-tuebingen.de

	with "subscribe" as the subject.
	
	To contribute to the mailing list, mail to

		lyx-users@fiwi02.wiwi.uni-tuebingen.de

	Please send unsubscription messages to lyx-users-request only!

	This mailing list is mirrored and archived on the Web at

		http://bioclox.bot.biologie.uni-tuebingen.de/
				mailing-archive/lyxlist/maillist.html

	courtesy of Dirk Engelmann.

There is also a mailing list for developers available:

	This list is intended only for the discussion of subjects
	relevant to the implementation, planning, hacking and
	improvement of LyX.

	To subscribe send mail to 

		majordomo@via.ecp.fr

	with in *BODY*:

		subscribe lyx
		end

	To contribute to the mailing list, mail to

		lyx@via.ecp.fr

	Please send unsubscription messages to majordomo@via.ecp.fr only!

	This mailing list is mirrored and archived on the Web at

	        http://www.via.ecp.fr/~andre/lyx/archive/

Other Internet resources of relevance to LyX

	Main LyX archive site:
	ftp://ftp.via.ecp.fr/pub/lyx/

	The LyX homepage contains valuable information, including links
	to other LyX homepages around the world:
	http://la1ad.uio.no/lyx/

	Other LyX archive sites are available at:
	ftp://fiwi02.wiwi.uni-tuebingen.de/pub/LyX/
	ftp://ftp.ibp.fr/pub/lyx/
	ftp://ftp.sdsc.edu/pub/other/lyx/
	ftp://ftp.fciencias.unam.mx/pub/Lyx/

	The latest development source can sporadically be found at:
	ftp://la1ad.uio.no/pub/lyx/
	http://la1ad.uio.no/lyx/

	The user's mailing list is archived at:
	http://bioclox.bot.biologie.uni-tuebingen.de/
			mailing-archive/lyxlist/maillist.html

	The developer's mailing list is archived at:
        http://www.via.ecp.fr/~andre/lyx/archive/

How is the numbering scheme for releases? Like the Linux kernel?

	Yes, it's like the Linux kernel since LyX version 0.8:

		0.8.x, 0.10.x, 0.12.x ... are stable, public releases
		0.9.x, 0.11.x, 0.13.x ... are developer releases

	Of course you may also use the developer releases, but only
	at your own risk. This is definitely higher than your risk when 
	using the public releases, even if this is your own risk, too.
	
	Sometimes, things called "snapshots" are released. Those are
	developer releases, so stay away from those unless you feel
	adventurous and want to help finding bugs.

You may get updates and patches via anonymous ftp from

	ftp://ftp.via.ecp.fr/pub/lyx/incoming/

	See above for mirrors.

	You can also try Henner Zeller's Patch-Tracker at

	http://lemming.stud.fh-heilbronn.de/~zeller/lyxpatchlist.html

How do I apply a patch?

	Go to the root of the source distribution and type:
	
		patch -p1 -E <../name_of_patch

	if the unpacked patch-file is in the directory above.

	Sometimes, the patch will not work as intended, so do a 

		find . -name '*.rej' 

	to see if you had any rejects. Often the rejects are cosmetical,
	but sometimes you need to fix them by hand. Other times, that can
	be very difficult, so just wait for the next release. They come 
	every other week or so.

How do I submit a bug report?

	If possible, read the "Known Bugs" document found under the
	Help menu.  You'll find detailed info on submitting bug reports
	there.

	You should also check the BUGS file in this directory.

	If you can't do that, send details to lyx@via.ecp.fr.  Don't forget
	to mention which version you are having problems with!

How do I prepare a binary distribution for the use of others?

	1) Compile LyX with the right compiler switches for your
	architecture. In particular you might want to ensure that libraries
	like xforms and xpm are statically linked. Moreover, make sure
	you use the --without-latex-config switch of configure, since
	others might not be interested by your configuration :-)

	2) Create a file README.bin describing your distribution and
	referring to *you* if problems arise. As a model, you can use the 
	file development/tools/README.bin.example which was originally
	written for Linux by David L. Johnson. Do *not* use directly
	the file in the distribution, since it refers to Linux and
	points to David L. Johnson for help. However, it can be a good
	starting point. Note that removing the file completely is
	better than not	editing it at all.

	3) Type `make bindist'. This will create a file
	lyx-0.xx.yy-bin.tar.gz. Rename it to reflect you architecture 
	and the peculiarities of your build (e.g. static vs. dynamic).

	4) Check that everything is correct by unpacking the distribution 
	in some private place and running it. In particular, check the 
	output of `ldd lyx' to know which libraries are really needed.

	5) Upload your binary file to ftp.via.ecp.fr:/pub/lyx/uploads.

How can I participate in the development of LyX? 

	Any help with the development of LyX is greatly appreciated--
	after all LyX wouldn't be what it is today without the help
	of volunteers. We need your help!

	The LyX project was started by Matthias Ettrich in 1995, and
	has since then grown from his single efforts on Linux to a 
	project involving many people on different platforms in
	different countries.

	In the beginning, Matthias took care of the code base and
	patches were sent to him personally, but as the project
	grew, he handed over the maintenance job to Lars Gullik
	Bjoennes, so he could spent more time hacking the code.
	
	Since spring 1996, Lars has maintained the code, but once
	again the project outgrew the structure, so in the summer 
	of 1996, the documentation effort was handed over to 
	John Weiss, who organized this part of LyX until fall 1997,
	where he stepped down as organizer after reorganizing the entire 
	documentation.

	Now, the documentation is maintained collectively.
		
	If you want to work on LyX, you should contact the developer's 
	mailing list for discussion on how to do your stuff.  LyX is being 
	cleaned up, and therefor it's important to follow some rules. 
	Read about those rules in development/Code_rules/.

	Notice that other contributions to the LyX project in general,
	such as *external* code don't fall in this category and can be 
	written in whatever way preferred.

	Patches for the main source tree should be prepared with the 
	makepatch utility found in

		development/tools/makepatch

	and should be done against the latest version of LyX with
	all other patches applied.
	
	Every patch should update the CHANGES file at the top only, and 
	maybe also the CREDITS file.

	If you feel confident that the patch doesn't break anything,
	and it's not covered by one of the above areas, you should mail
	the uuencoded patch prepared by makepatch to

		lyxpatches@via.ecp.fr

	and then send a mail to the developer's mailing list 
|	at lyx@via.ecp.fr describing the changes when you've 
	confirmed that the file arrived safely at via.ecp.fr 
	(check the file size in the receipt mail).

Thank you for trying LyX, and we appreciate your feedback in the mailing
lists.

The LyX Team.
(lyx@via.ecp.fr)
