X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.txt;h=4eed4cb48e0867cb7b7cd59974983b2eb9ece453;hb=e7d84e6728ecfdf74d8f214486a29c2aca199819;hp=d5dd11f03764980172df6ab79802fc3b1b773564;hpb=3d59b15cfcb500305c85f2f58d708e09c81a6b95;p=lilypond.git diff --git a/README.txt b/README.txt index d5dd11f037..4eed4cb48e 100644 --- a/README.txt +++ b/README.txt @@ -1,103 +1,101 @@ - This is the toplevel README to LilyPond -LilyPond is a music typesetter. It produces beautiful sheet -music using a high level description file as input. Lily- -Pond is part of the GNU Project. +This is the toplevel README to LilyPond +*************************************** -1: VERSIONING + 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. -LilyPond uses a versioning scheme similar to the Linux ker- -nel. 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. +Versioning +========== -2: REQUIREMENTS + 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 the compilation and running of LilyPond you need some -additional packages. Please refer to the installation -instructions. +Requirements +============ -NOTE: If you downloaded a binary (.rpm or a W95/NT .zip -file), then you don't have to compile LilyPond. + For the compilation and running of LilyPond you need some additional +packages. Please refer to the installation instructions. -3: INSTALLATION + NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you +don't have to compile LilyPond. -For your convenience, a formatted copy of the INSTALL -instructions are in the toplevel directory, as INSTALL.txt +Installation +============ -The process is fairly straightforward, but chances are that -you have to specify directories for to configure: this is -done with the options --enable-tex-dir and --enable-mf-dir + For your convenience, a formatted copy of the INSTALL instructions +are in the toplevel directory, as INSTALL.txt -4: DOCUMENTATION +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: + If you want to read the documentation online, these are options: + * use HTML. Refer to INSTALL.txt for information on how to make the + HTML documentation. -o use .html. Refer to INSTALL.txt for info on how to make - the .html documentation. + * use HTML. Point your browser to + `http://www.cs.uu.nl/~hanwen/lilypond/index.html'. -o use .html. Point your browser to - http://www.cs.uu.nl/~hanwen/lilypond/index.html. + * use `.dvi', for the tutorial and reference manual. Do -o use .dvi, for the tutorial and reference manual. Do + make -C Documentation/user/ dvi - make -C Documentation/tex/ dvi + You need a working LilyPond binary to create the DVI sources . -o use ASCII. Do using + * use ASCII. Do using + make doc - make -C Documentation/ - The tutorial and the reference manual can not be made - in ASCII, as they contain graphics. +Comments +======== -5: COMMENTS + LilyPond is a long way from finished and polished. We do appreciate +criticism, comments, bugreports, patches, etc., but please, -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/mail.texi' for more +info. -and not to us personally. See Documentation/links.yo for -more info. +Windows 32 +========== -6: WINDOWS 32 + If you have received this file as part of a DOS/Window32 distribution +(`LilyPond-*.zip'), it is advisable to also download the source +package, since it might contain more documentation +`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/' -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/ + 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 - -* Please read the file BUGS for some ugly bugs. - -* If you have installed a previous version, be sure to -remove old font files, eg +Caveats +======= + 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 + a script to do this for you is in `buildscripts/clean-fonts.sh' -8: BUGS +Bugs +==== -Send bug reports to bug-gnu-music@gnu.org. For help and -questions use help-gnu-music@gnu.org and gnu-music-dis- -cuss@gnu.org. Please consult the faq before mailing your + Send bug reports to . For help and questions +use and . Please +consult the FAQ and installation instructions before mailing your problems. -9: CDROM DISTRIBUTIONS +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. -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.