X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.txt;h=b254f58698b253a79af6926ba693f94abf0fd2c1;hb=331c093a4324764240e7f2e89e36b8216d4d9b23;hp=2008fc4f8c29743a7c8ac4216c6695fb4561fb80;hpb=1cf3d59c1559fb9774c4c1c8cae155cfe54a927c;p=lilypond.git diff --git a/README.txt b/README.txt index 2008fc4f8c..b254f58698 100644 --- a/README.txt +++ b/README.txt @@ -1,88 +1,99 @@ -This is the toplevel README to LilyPond - - 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, formatting scores, part extraction. It includes -a nice font of musical symbols. -1: VERSIONING +This is the toplevel README to LilyPond +*************************************** -if you have downloaded a + 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. - *.pre* +Versioning +========== -version, then this is version is *not* meant for producing nice output -(but to keep your patchsets up to date). It might not even compile. + 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. -2: REQUIREMENTS +Requirements +============ -For the compilation and running of LilyPond you need some additional + 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), then + NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then you don't have to compile LilyPond. -3: INSTALLATION +Installation +============ -For your convenience, a formatted copy of the INSTALL instructions are -in the toplevel directory, as INSTALL.txt + For your convenience, a formatted copy of the INSTALL instructions +are in the toplevel directory, as INSTALL.txt -The process is fairly straightforward, but chances are that you have -to specify directories for TeX to configure (--enable-tex-dir, ---enable-mf-dir) +Documentation +============= -4: DOCUMENTATION + The real documentation is the directory Documentation/ -The real documentation is the directory Documentation/ + If you want to read the documentation online, these are options: + * use `.html'. Refer to INSTALL.txt for info on how to make the + .html documentation. -To generate the pretty-printed docs, you have to run configure first, -and then do this: + * use `.html'. Point your browser to + `http://www.cs.uu.nl/~hanwen/lilypond/index.html'. - make doc + * use `.dvi', for the tutorial and reference manual. Do -You can also simply read the .yo sources. They are ASCII text. -The complete documentation is accessible in formatted form at the -website + make -C Documentation/tex/ dvi - http://www.cs.uu.nl/people/hanwen/lilypond/index.html + * use ASCII. Do using + make -C Documentation/ -5: COMMENTS -LilyPond is a long way from finished and polished. We do appreciate +Comments +======== + + LilyPond is a long way from finished and polished. We do appreciate criticism, comments, bugreports, patches, etc. - Please send your e-mail to one of the MAILING LISTS + Please send your e-mail to one of the MAILING LISTS -and not to us personally. See Documentation/links.yo for more info. + and _not_ to us personally. See `Documentation/mail.texi' for more +info. -6: DOZE +Windows 32 +========== -If you have received this file as part of a DOS/Window32 distribution -(lilypond-*.zip), then it is advisable to also download the source + 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/' - ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe) - -If you decide to build LilyPond from source, please read the INSTALL.txt -document first, especially the Windows NT/95 section. + If you decide to build LilyPond from source, please read the +INSTALL.txt document first, especially the Windows NT/95 section. -7: CAVEATS +Caveats +======= -* Please read the file BUGS for some ugly bugs. This especially applies -Linux-Intel unix users. + If you have installed a previous version, be sure to remove old font +files, eg., + rm `find /var/lib/texmf/fonts -name 'feta*'` -* If you have installed a previous version, be sure to remove old font -files, eg + a script to do this for you is in `buildscripts/clean-fonts.sh' - rm `find /var/lib/texmf/fonts -name 'feta*'` +Bugs +==== -a script to do this for you is in bin/cleanfonts.sh + Send bug reports to . For help and questions +use and . Please +consult the FAQ and installation instructions before mailing your +problems. -8: CDROM DISTRIBUTIONS +CDROM distributions +=================== -If you have received LilyPond on a cdrom, chances are that development -has moved a some patchlevels up. If possible, please check the latest + 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. +