\input texinfo @c -*-texinfo-*-
@setfilename README.info
-@settitle This is the toplevel README to LilyPond
+@settitle Toplevel README
+
+@html
+<!--- @@WEB-TITLE@@=README --->
+@end html
+
@node Top, , ,
@top
-@chapter This is the toplevel README to LilyPond
+@chapter Toplevel README
-LilyPond is a music typesetter. It produces beautiful sheet music
-using a high level description file as input. LilyPond is part of
-the GNU Project.
+LilyPond is a music typesetter. It produces beautiful sheet music
+using a description file as input. LilyPond is part of the GNU
+Project.
@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.
-@section Requirements
+Version 1.6 is the latest stable release.
-For the compilation and running of LilyPond you need some additional
-packages. Please refer to the installation instructions.
+@section Downloading
-NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
-you don't have to compile LilyPond.
+The primary download site for sourcecode is
+@uref{ftp://ftp.lilypond.org/pub/GNU/LilyPond/}.
-@section Installation
+If you have a slow connection, then you are advised to use
+@uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/,xdelta} for patching
+source archives; Xdelta (@file{.xd}) files are supplied on the FTP site.
-For your convenience, a formatted copy of the INSTALL instructions are
-in the toplevel directory, as INSTALL.txt
+@section Compilation
-@section Documentation
+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}. They are also
+available on the web at
+@uref{http://lilypond.org/Documentation/topdocs/out-www/INSTALL.html}.
-The real documentation is the directory Documentation/
+NOTE: If you downloaded a binary (@file{.rpm}) or use the Cygwin
+@file{setup.exe} program, then you don't have to compile LilyPond.
-If you want to read the documentation online, these are options:
-@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
-@example
- make -C Documentation/user/ dvi
-@end example
+@section Documentation
-
-@item use ASCII. Do
-using @example
- make -C doc
-@end example
+The documentation is available online at
+@uref{http://www.lilypond.org/Documentation/out-www/index.html}.
-@end itemize
+You can also build it locally: follow the instructions under `Building
+documentation in the installation instructions.
@section Comments
-LilyPond is a long way from finished and polished. We do appreciate
-criticism, comments, bugreports, patches, etc., but please,
-@example
-
- Please send your e-mail to one of the MAILING LISTS
-
-@end example
+LilyPond is a long way from finished so we appreciate your criticism,
+comments, bugreports, patches, etc. Please send them to the mailing
+list, not to us personally.
-and @emph{not} to us personally. See @file{Documentation/mail.texi} for
-more info.
+@html
+<a name="mailing-lists">
+@end html
-@section Windows 32
+We have the following mailing lists:
-If you have received this file as part of a DOS/Window32 distribution
-(@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/}
+@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.
+
+@item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-cvs,lilypond-cvs@@gnu.org}
+ Commit messages for CVS development. This is a high-volume moderated
+ list.
+@end itemize
-If you decide to build LilyPond from source, please read the INSTALL.txt
-document first, especially the Windows NT/95 section.
+You can search the lists from the following page:
+@uref{http://lilypond.org/search, searching facilities}.
@section Caveats
If you have installed a previous version, be sure to remove old font
-files, eg.,
+files, e.g.,
@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}
+a script to do this for you is left
+@file{buildscripts/out/clean-fonts}
@section Bugs
-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.
-
-@section CDROM distributions
-
-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.
+Send bug reports to @email{bug-lilypond@@gnu.org}. For help and
+questions use @email{lilypond-user@@gnu.org}. Please consult the
+documentation before mailing your problems.
@bye
projects / lilypond.git / blobdiff