\input texinfo @c -*-texinfo-*-
@setfilename README.info
@settitle This is the toplevel README to LilyPond
-
-@node Top, , cdrom distributions, (dir)
+@node Top, , ,
@top
-@menu
-* This is the toplevel README to LilyPond::This is the toplevel README to LilyPond
-@end menu
-
-
-
-@node This is the toplevel README to LilyPond, versioning, , Top
-@menu
-* versioning:: versioning
-* requirements:: requirements
-* installation:: installation
-* documentation:: documentation
-* comments:: comments
-* windows 32:: windows 32
-* caveats:: caveats
-* bugs:: bugs
-* cdrom distributions:: cdrom distributions
-@end menu
@chapter This is the toplevel README to LilyPond
using a high level description file as input. LilyPond is part of
the GNU Project.
-@node versioning, requirements, This is the toplevel README to LilyPond, This is the toplevel README to LilyPond
-@section versioning
+@section Versioning
LilyPond uses a versioning scheme similar to the Linux kernel. In a
version "x.y.z", an even second number 'y' denotes a stable version.
production, please use the latest stable version. Development versions
may not produce good or nice scores.
-@node requirements, installation, versioning, This is the toplevel README to LilyPond
-@section requirements
+@section Requirements
For the compilation and running of LilyPond 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
+NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
you don't have to compile LilyPond.
-@node installation, documentation, requirements, This is the toplevel README to LilyPond
-@section installation
+@section Installation
For your convenience, a formatted copy of the INSTALL instructions are
in the toplevel directory, as INSTALL.txt
-@node documentation, comments, installation, This is the toplevel README to LilyPond
-@section documentation
+@section Documentation
The real documentation is the directory Documentation/
@item use @file{.dvi}, for the tutorial and reference manual. Do
@example
- make -C Documentation/tex/ dvi
+ make -C Documentation/user/ dvi
@end example
@item use ASCII. Do
using @example
- make -C Documentation/
+ make -C doc
@end example
@end itemize
-@node comments, windows 32, documentation, This is the toplevel README to LilyPond
-@section comments
+@section Comments
LilyPond is a long way from finished and polished. We do appreciate
criticism, comments, bugreports, patches, etc.
@end example
-and @emph{not} to us personally. See @file{Documentation/links.yo} for more info.
+and @emph{not} to us personally. See @file{Documentation/mail.texi} for
+more info.
-@node windows 32, caveats, comments, This is the toplevel README to LilyPond
-@section windows 32
+@section Windows 32
If you have received this file as part of a DOS/Window32 distribution
-(LilyPond-*.zip), then it is advisable to also download the source
-package, since it might contain more documentation
+(@file{LilyPond-*.zip}), it is advisable to also download the
+source package, since it might contain more documentation
@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}
If you decide to build LilyPond from source, please read the INSTALL.txt
document first, especially the Windows NT/95 section.
-@node caveats, bugs, windows 32, This is the toplevel README to LilyPond
-@section caveats
-
-* Please read the file BUGS for some ugly bugs.
+@section Caveats
-* If you have installed a previous version, be sure to remove old font
-files, eg
+If you have installed a previous version, be sure to remove old font
+files, eg.,
@example
rm `find /var/lib/texmf/fonts -name 'feta*'`
@end example
a script to do this for you is in @file{buildscripts/clean-fonts.sh}
-@node bugs, cdrom distributions, caveats, This is the toplevel README to LilyPond
-@section bugs
+@section Bugs
-Send bug reports to bug-gnu-music@@gnu.org. For help and questions use
-help-gnu-music@@gnu.org and gnu-music-discuss@@gnu.org. Please consult
-the faq before mailing your problems.
+Send bug reports to @email{bug-gnu-music@@gnu.org}. For help and
+questions use @email{help-gnu-music@@gnu.org} and
+@email{gnu-music-discuss@@gnu.org}. Please consult the FAQ and
+installation instructions before mailing your problems.
-@node cdrom distributions, Top, bugs, This is the toplevel README to LilyPond
-@section cdrom distributions
+@section CDROM distributions
-if you have received LilyPond on a cdrom, chances are that development
-has moved a some patchlevels up. Please check the latest version of
+If you have received LilyPond on a cdrom, chances are that development
+has moved some patchlevels up. Please check the latest version of
LilyPond before reporting bugs.
projects / lilypond.git / blobdiff