]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/README.texi
release: 1.3.147
[lilypond.git] / Documentation / topdocs / README.texi
index eeb64dca85a1c8e303deffed4a7d9449a268f353..c10fa8db2add931b92c8877d76242eac1cf040cf 100644 (file)
@@ -15,14 +15,19 @@ 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.  So, in theory, version 1.2 is stable,
+which means that there are no glaring errors in it. In practice 1.2.x is also
+unmaintained.
+
+1.3.x is in healthy development: lots of problems turn up, but they're
+fixed quickly. Therefore we recommend you try 1.2.x, if you have any
+problem with it, upgrade to the latest 1.3.x release.
 
 @section Requirements
 
 For the compilation and running of LilyPond you need some additional
-packages.  Please refer to the installation instructions.
+packages.  Please refer to the installation instructions in
+@file{INSTALL.txt}.
 
 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
 you don't have to compile LilyPond.
@@ -34,45 +39,53 @@ 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.cs.uu.nl/~hanwen/lilypond/index.html}.  You can also
+build it locally. This does require a working LilyPond binary.  The
+following formats are supported:
 @itemize @bullet
 
-@item  use HTML. Refer to INSTALL.txt for information
+@item HTML. Refer to INSTALL.txt for information
 on how to make the HTML documentation.
 
-@item  use 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 @file{.dvi},  for the tutorial and reference manual. Do
 @example 
-  make -C Documentation/user/ dvi 
-@end example 
 
-You need a working LilyPond binary to create the DVI sources  .
+ make -C Documentation/user/ dvi 
 
-@item  use ASCII. Do
-using @example 
-       make -C doc
 @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., but please,
-@example 
+LilyPond is a long way from finished and polished, so we please send
+your criticism, comments, bugreports, patches, etc., to the mailing
+list.  and @emph{not} to us personally.
 
-          Please send your e-mail to one of the MAILING LISTS
-@end example 
+We have the following mailing lists:
+
+@itemize @bullet
+@item @uref{http://mail.gnu.org/mailman/listinfo/info-gnu-music,info-gnu-music@@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/gnu-music-discuss,gnu-music-discuss@@gnu.org}
+  For general discussions concerning LilyPond.
+
+@item @uref{http://mail.gnu.org/mailman/listinfo/help-gnu-music,help-gnu-music@@gnu.org}
+    For help with using LilyPond.
+@item @uref{http://mail.gnu.org/mailman/listinfo/bug-gnu-music,bug-gnu-music@@gnu.org}
+If you have bugreports, you should send them to this list.
+@end itemize
 
-and @emph{not} to us personally.  See @file{Documentation/mail.texi} for
-more info.
 
 @section Windows 32
 
@@ -81,9 +94,6 @@ If you have received this file as part of a DOS/Window32 distribution
 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.
-
 @section Caveats
 
 If you have installed a previous version, be sure to remove old font
@@ -101,11 +111,6 @@ 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.
 
 
 @bye