]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/README.texi
release: 1.5.9
[lilypond.git] / Documentation / topdocs / README.texi
index 8f76f1f67347842dbc1d496dfcd9780ffd457b7e..2c97cb4c6c29ec12527fb58f796e69a5f1886f99 100644 (file)
@@ -15,70 +15,85 @@ the GNU Project.
 
 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.4 is the latest stable release.
+
+
+@section Compilation
+
+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 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),
 you don't have to compile LilyPond.
 
-@section Installation
-
-For your convenience, a formatted copy of the INSTALL instructions are
-in the toplevel directory, as INSTALL.txt
 
 @section Documentation
 
-The real documentation is the directory 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/user/ dvi 
-@end example 
 
-  
-@item  use ASCII. Do
-using @example 
-       make -C doc
+ 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
 
 
 @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.
+
+@html
+<a name="mailing-lists">
+@end html
+
 
-          Please send your e-mail to one of the MAILING LISTS
-@end example 
 
-and @emph{not} to us personally.  See @file{Documentation/mail.texi} for
-more info.
+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
+
 
 @section Windows 32
 
 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/}
-
-If you decide to build LilyPond from source, please read the INSTALL.txt
-document first, especially the Windows NT/95 section.
+@uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,source package}, since it
+might contain more documentation
 
 @section Caveats
 
@@ -92,16 +107,10 @@ a script to do this for you is in @file{buildscripts/clean-fonts.sh}
 
 @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
+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 some patchlevels up.  Please check the latest version of
-LilyPond before reporting bugs.
 
 
 @bye