X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Ftopdocs%2FREADME.texi;h=b63756d55675f5326113044d6a08f74e2bd40006;hb=d755d476635be4b73252d2204e7b25bddba64056;hp=d7eb7764b80bb7bbce6685cfdaeeabb9a77df5dc;hpb=e4a2733b4c0ab484305dc19fc598d70a9631539b;p=lilypond.git diff --git a/Documentation/topdocs/README.texi b/Documentation/topdocs/README.texi index d7eb7764b8..b63756d556 100644 --- a/Documentation/topdocs/README.texi +++ b/Documentation/topdocs/README.texi @@ -1,135 +1,94 @@ \input texinfo @c -*-texinfo-*- @setfilename README.info -@settitle This is the toplevel README to LilyPond +@settitle Toplevel README -@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 +@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. - -@node requirements, installation, versioning, This is the toplevel README to LilyPond -@section requirements +For development versions 'y' is odd. -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), then -you don't have to compile LilyPond. +The primary download site for sourcecode is +@uref{http://lilypond.org/download/}. -@node installation, documentation, requirements, This is the toplevel README to LilyPond -@section installation +If you have a slow connection, then you are advised to use +@uref{http://sourceforge.net/projects/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 -@node documentation, comments, installation, This is the toplevel README to LilyPond -@section documentation +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.1/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/tex/ dvi -@end example - - -@item use ASCII. Do -using @example - make -C Documentation/ -@end example - -@end itemize +@section Documentation -@node comments, windows 32, documentation, This is the toplevel README to LilyPond -@section comments +The documentation is available online at +@uref{http://www.lilypond.org/doc/}. -LilyPond is a long way from finished and polished. We do appreciate -criticism, comments, bugreports, patches, etc. -@example +You can also build it locally: follow the instructions under `Building +documentation' in the installation instructions. - Please send your e-mail to one of the MAILING LISTS - -@end example -and @emph{not} to us personally. See @file{Documentation/links.yo} for more info. +@section Comments -@node windows 32, caveats, comments, This is the toplevel README to LilyPond -@section windows 32 +Send your criticism, comments, bugreports, patches, etc. to the mailing +list, not to us personally. -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/} +@html + +@end html -If you decide to build LilyPond from source, please read the INSTALL.txt -document first, especially the Windows NT/95 section. +We have the following mailing lists: -@node caveats, bugs, windows 32, This is the toplevel README to LilyPond -@section caveats - -* Please read the file BUGS for some ugly bugs. - -* 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 +@itemize @bullet +@item @uref{http://mail.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@@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} +for sending bugreports. + +@item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-cvs,lilypond-cvs@@gnu.org} + for commit messages in CVS development. This is a high-volume moderated + list. +@end itemize -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. +You can search the lists from the following page: +@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