COMMENT(-*-Text-*-)

notableofcontents()
article(README)()()

DEFINEMACRO(Package)(0)(Yodl) DEFINEMACRO(package)(0)(yodl)
redef(XXsetchapternum)(0)()

This is the toplevel README to Package()

nl()

includefile(../BLURB.in)

sect(VERSIONING)

if you have downloaded a

	*.pre*

version, then this is version is *not* meant for producing nice output
(but to keep your patchsets up to date).  It might not even compile.


sect(REQUIREMENTS)

For the compilation and running of Package() you need some additional
packages.  Please refer to the installation instructions.

NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
you don't have to compile Package().


sect(INSTALLATION)

For your convenience, a formatted copy of the INSTALL instructions are
in the toplevel directory, as INSTALL.txt

The process is fairly straightforward, but chances are that you have
to specify directories for TeX to configure (--enable-tex-dir,
--enable-mf-dir)


sect(DOCUMENTATION)

The real documentation is the directory Documentation/

To generate the pretty-printed docs, you have to run configure first,
and then do this:

	make doc

You can also simply read the .yo sources.  They are ASCII text.
The complete documentation is accessible in formatted form at the 
website

        http://www.cs.uu.nl/people/hanwen/yodl/


sect(COMMENTS)

Package() is a long way from finished and polished.  We do appreciate
criticism, comments, bugreports, patches, etc.

	   Please send your e-mail to one of the MAILING LISTS

and not to us personally.  See Documentation/links.yo for more info.


sect(DOZE)

If you have received this file as part of a DOS/Window32 distribution
(package()-*.zip), then it is advisable to also download the source
package, since it might contain more documentation

	ftp://ftp.lilypond.org/pub/package()/ (Europe)

If you decide to build Package() from source, please read the INSTALL.txt
document first, especially the Windows NT/95 section.


sect(CDROM DISTRIBUTIONS)

If you have received Package() on a cdrom, chances are that development
has moved a some patchlevels up.  If possible, please check the latest 
version of Package() before reporting bugs.

