]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/topdocs/README.texi
Issue 4668: README: replace lilypond-cvs list info with lilypond-auto
[lilypond.git] / Documentation / topdocs / README.texi
index 91b663fd488269afb6b40570d761f7b903d6ccb5..e282c32fba41326ebbb1a7e86bdd536857a23dfa 100644 (file)
 \input texinfo @c -*-texinfo-*-
+@documentencoding UTF-8
+@documentlanguage en
 @setfilename README.info
-@settitle This is the toplevel README to LilyPond
-
-@node Top, , cdrom distributions, (dir)
-@top
-@menu
-* This is the toplevel README to LilyPond::This is the toplevel README to LilyPond
-@end menu
-
+@settitle Toplevel README
 
 
+@node Top
+@top
 
-@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
+@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.
+using a 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.
+LilyPond uses a versioning scheme that easily identifies stable and
+development releases.  In a version "x.y.z", an even second number 'y'
+denotes a stable version.  For development versions 'y' is odd.
 
-@node requirements, installation, versioning, This is the toplevel README to LilyPond
-@section requirements
+@section Downloading
 
-For the compilation and running of LilyPond you need some additional
-packages.  Please refer to the installation instructions.
+The primary download site for sourcecode is
+@uref{http://lilypond.org/download/}.
 
-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 see 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/doc/v2.12/Documentation/topdocs/INSTALL.html}.
 
-For your convenience, a formatted copy of the INSTALL instructions are
-in the toplevel directory, as INSTALL.txt
+@section Documentation
 
-@node documentation, comments, installation, This is the toplevel README to LilyPond
-@section documentation
+The documentation is available online at
+@uref{http://lilypond.org/doc/}.
 
-The real documentation is the directory Documentation/
+You can also build it locally: follow the instructions under `Building
+documentation' in the installation instructions.
 
-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/tex/ dvi 
-@end example 
-
-  
-@item  use ASCII. Do
-using @example 
-       make -C Documentation/
-@end example 
-
-@end itemize
 
+@section Comments
 
-@node comments, windows 32, documentation, This is the toplevel README to LilyPond
-@section comments
+Send your criticism, comments, bugreports, patches, etc. to the mailing
+list, not to us personally.
 
-LilyPond is a long way from finished and polished.  We do appreciate
-criticism, comments, bugreports, patches, etc.
-@example 
+@html
+<a name="mailing-lists">
+@end html
 
-          Please send your e-mail to one of the MAILING LISTS
-@end example 
+We have the following mailing lists:
 
-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
-(@file{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/}
-
-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
+@itemize @bullet
+@item @uref{http://lists.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
+is a low-volume list for information on LilyPond project.
+    This list is moderated; ask
+    @email{drl@@gnu.org, David R. Linn} or
+    @email{hanwen@@xs4all.nl, Han-Wen} to send announcements for this
+list.
 
-* Please read the file BUGS for some ugly bugs.  
+@item
+@uref{http://lists.gnu.org/mailman/listinfo/lilypond-devel,lilypond-devel@@gnu.org}
+  for discussions about developing LilyPond, in particular the unstable series.
 
-* 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 
+@item @uref{http://lists.gnu.org/mailman/listinfo/lilypond-user,lilypond-user@@gnu.org}
+  for discussions about using LilyPond, in particular the stable series.
 
-a script to do this for you is in @file{buildscripts/clean-fonts.sh}
+@item @uref{http://lists.gnu.org/mailman/listinfo/bug-lilypond,bug-lilypond@@gnu.org}
+for sending bugreports.
 
-@node bugs, cdrom distributions, caveats, This is the toplevel README to LilyPond
-@section bugs
+@item @uref{http://lists.gnu.org/mailman/listinfo/lilypond-auto,lilypond-auto@@gnu.org}
+ for notifications from the issue tracking systems of LilyPond.
+@end itemize
 
-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 before mailing your problems.
+You can search the lists from our @uref{http://lilypond.org/search,
+searching facilities}.
 
-@node cdrom distributions, Top, bugs, This is the toplevel README to LilyPond
-@section cdrom distributions
+@section Bugs
 
-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.
+Send bug reports to @email{bug-lilypond@@gnu.org}.  For help and
+questions use @email{lilypond-user@@gnu.org}.
 
 
 @bye