\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.
-For development versions 'y' is odd. For using straightforward score
-production, please use the latest stable version. Development versions
-may not produce good or nice scores.
+For development versions 'y' is odd.
-@node requirements, installation, versioning, This is the toplevel README to LilyPond
-@section requirements
+Version 1.4 is the latest stable release.
-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
-you don't have to compile LilyPond.
+@section Compilation
-@node installation, documentation, requirements, This is the toplevel README to LilyPond
-@section installation
+For compiling and running LilyPond please refer to the installation
+instructions. These instructions can be found when you unpack lilypond,
+as @file{lilypond-x.y.z/INSTALL.txt}.
-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
+NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
+you don't have to compile LilyPond.
+
-The real documentation is the directory Documentation/
+@section Documentation
-If you want to read the documentation online, these are options:
+The documentation is available online at
+@uref{http://www.lilypond.org/}. You can also build it locally. This
+does require a working LilyPond binary. The following formats are
+supported:
@itemize @bullet
-@item use @file{.html}. Refer to INSTALL.txt for info on how to make the
-.html documentation.
-@item use @file{.html}. Point your browser to
-@uref{http://www.cs.uu.nl/~hanwen/lilypond/index.html}.
-@item use @file{.dvi}, for the tutorial and reference manual. Do
+@item HTML. Refer to INSTALL.txt for information
+on how to make the HTML documentation.
+
+@item @file{.dvi}, for the tutorial and reference manual. Do
@example
- make -C Documentation/tex/ dvi
-@end example
-
-@item use ASCII. Do
-using @example
- make -C Documentation/
+ make -C Documentation/user/ dvi
+
@end example
+The printable documentation is left in @file{Documentation/user/out/}.
+
+@item paper. Create the .dvi documentation, and print it with dvips.
@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.
-@example
+LilyPond is a long way from finished and polished, so please send your
+criticism, comments, bugreports, patches, etc., to the mailing list,
+@emph{not} to us personally.
- Please send your e-mail to one of the MAILING LISTS
-
-@end example
+@html
+<a name="mailing-lists">
+@end html
-and @emph{not} to us personally. See @file{Documentation/links.yo} for more info.
-@node windows 32, caveats, comments, This is the toplevel README to LilyPond
-@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
-@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}
+We have the following mailing lists:
+
+@itemize @bullet
+@item @uref{http://mail.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
+is a low-volume list for information on the GNU Music project.
+ This list is moderated; ask
+ @email{drl@@gnu.org, David R. Linn} or
+ @email{hanwen@@cs.uu.nl, Han-Wen} to send announcements for this
+list.
+@item
+@uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,lilypond-devel@@gnu.org}
+ For discussions about developing lilypond, in particular the unstable series.
+
+@item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,lilypond-user@@gnu.org}
+ For discussions about using lilypond, in particular the stable series.
+
+@item @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,bug-lilypond@@gnu.org}
+If you have bugreports, you should send them to this list.
+@end itemize
-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
+@section Windows 32
-* Please read the file BUGS for some ugly bugs.
+If you have received this file as part of a DOS/Window32 distribution
+(@file{LilyPond-*.zip}), it is advisable to also download the
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,source package}, since it
+might contain more documentation
-* If you have installed a previous version, be sure to remove old font
-files, eg
+@section Caveats
+
+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
-
-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.
+@section Bugs
-@node cdrom distributions, Top, bugs, This is the toplevel README to LilyPond
-@section cdrom distributions
+Send bug reports to @email{bug-lilypond@@gnu.org}. For help and
+questions use @email{lilypond-user@@gnu.org}. Please consult the FAQ
+and installation instructions before mailing your problems.
-if you have received LilyPond on a cdrom, chances are that development
-has moved a some patchlevels up. Please check the latest version of
-LilyPond before reporting bugs.
@bye
projects / lilypond.git / blobdiff