X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.txt;h=09f0f1847aa9502b719570110be2a62c3d872062;hb=57ca7c6601ed88f6f5a02cb0724d1e87ff148b83;hp=e96abe18a2b7bfb7789374b72e30dd478a986b77;hpb=78ed9c22a8cbf56ff5390553e0a2854aa42cbbc5;p=lilypond.git diff --git a/README.txt b/README.txt index e96abe18a2..09f0f1847a 100644 --- a/README.txt +++ b/README.txt @@ -1,82 +1,78 @@ +Toplevel README +*************** -TITLE INFORMATION: This is the toplevel README to LilyPond +1 Toplevel README +***************** - LilyPond is the GNU Project music typesetter. This program can print -beautiful sheet music from a music definition file. It can also play -mechanical performances to a MIDI file. Features include multiple -staffs, meters, clefs, keys, lyrics, versatile input language, cadenzas, -beams, slurs, triplets, named chords, transposing, formatting scores, -part extraction. It includes a nice font of musical symbols. +LilyPond is a music typesetter. It produces beautiful sheet music using +a description file as input. LilyPond is part of the GNU Project. -1: VERSIONING +1.1 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. -2: REQUIREMENTS +1.2 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 +. -NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then -you don't have to compile LilyPond. +1.3 Compilation +=============== -3: INSTALLATION +For compiling and running LilyPond see the installation instructions. +These instructions can be found when you unpack lilypond, as +‘lilypond-x.y.z/INSTALL.txt’. They are also available on the web at +. -For your convenience, a formatted copy of the INSTALL instructions are -in the toplevel directory, as INSTALL.txt +1.4 Documentation +================= -The process is fairly straightforward, but chances are that you have -to specify directories for TeX to configure: this is done with -the options --enable-tex-dir and --enable-mf-dir +The documentation is available online at . -4: DOCUMENTATION + You can also build it locally: follow the instructions under +‘Building documentation’ in the installation instructions. -The real documentation is the directory Documentation/ +1.5 Comments +============ -To generate the pretty-printed docs, you have to run configure first, -and then do this: +Send your criticism, comments, bugreports, patches, etc. to the mailing +list, not to us personally. - make doc + We have the following mailing lists: -You can also simply read the .yo sources. They are ASCII text. -The complete documentation is accessible in formatted form at the -website http://www.cs.uu.nl/people/hanwen/lilypond/index.html + • info-lilypond@gnu.org + (http://lists.gnu.org/mailman/listinfo/info-lilypond) is a + low-volume list for information on LilyPond project. This list is + moderated; ask David R. Linn or Han-Wen + to send announcements for this list. -5: COMMENTS + • lilypond-devel@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-devel) for + discussions about developing LilyPond, in particular the unstable + series. -LilyPond is a long way from finished and polished. We do appreciate -criticism, comments, bugreports, patches, etc. + • lilypond-user@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-user) for + discussions about using LilyPond, in particular the stable series. - Please send your e-mail to one of the MAILING LISTS + • bug-lilypond@gnu.org + (http://lists.gnu.org/mailman/listinfo/bug-lilypond) for sending + bugreports. -and not to us personally. See Documentation/links.yo for more info. + • lilypond-auto@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-auto) for + notifications from the issue tracking systems of LilyPond. -6: WINDOWS 32 + You can search the lists from our searching facilities +(http://lilypond.org/search). -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 -ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/ +1.6 Bugs +======== -If you decide to build LilyPond from source, please read the INSTALL.txt -document first, especially the Windows NT/95 section. +Send bug reports to . For help and questions use +. -7: 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 -rm `find /var/lib/texmf/fonts -name 'feta*'` - -a script to do this for you is in buildscripts/clean-fonts.sh - -8: CDROM DISTRIBUTIONS - -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.