X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.txt;h=6b35be73f5183bb933e75c9b03900877502336de;hb=c7188d81786abe6ee550a6f7b10e9b3923b8ebfa;hp=34ebbcad1367da1257c6257cf031161d3c06ce10;hpb=e4a2733b4c0ab484305dc19fc598d70a9631539b;p=lilypond.git diff --git a/README.txt b/README.txt index 34ebbcad13..6b35be73f5 100644 --- a/README.txt +++ b/README.txt @@ -1,109 +1,78 @@ +Toplevel README +*************** +1 Toplevel README +***************** - ) +LilyPond is a music typesetter. It produces beautiful sheet music +using a description file as input. LilyPond is part of the GNU Project. -This is the toplevel README to LilyPond -*************************************** +1.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 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. -versioning -========== +1.2 Downloading +=============== - 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. +The primary download site for sourcecode is +`http://lilypond.org/download/'. -requirements -============ - - For the compilation and running of LilyPond you need some additional -packages. Please refer to the installation instructions. +1.3 Compilation +=============== - NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then -you don't have to compile LilyPond. +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 +`http://lilypond.org/doc/v2.12/Documentation/topdocs/INSTALL.html'. -installation -============ +1.4 Documentation +================= - For your convenience, a formatted copy of the INSTALL instructions -are in the toplevel directory, as INSTALL.txt +The documentation is available online at `http://lilypond.org/doc/'. - 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' + You can also build it locally: follow the instructions under +`Building documentation' in the installation instructions. -documentation -============= +1.5 Comments +============ - The real documentation is the directory Documentation/ +Send your criticism, comments, bugreports, patches, etc. to the mailing +list, not to us personally. - 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. + We have the following mailing lists: - * use `.html'. Point your browser to - `http://www.cs.uu.nl/~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. - * use `.dvi', for the tutorial and reference manual. Do + * lilypond-devel@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-devel) for + discussions about developing LilyPond, in particular the unstable + series. - make -C Documentation/tex/ dvi + * lilypond-user@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-user) for + discussions about using LilyPond, in particular the stable series. - * use ASCII. Do using + * bug-lilypond@gnu.org + (http://lists.gnu.org/mailman/listinfo/bug-lilypond) for sending + bugreports. - make -C Documentation/ + * lilypond-cvs@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-cvs) for log + files from the autobuild. - The tutorial and the reference manual can not be made in ASCII, as - they contain graphics. + You can search the lists from our searching facilities +(http://lilypond.org/search). -comments +1.6 Bugs ======== - 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 - - and _not_ to us personally. See `Documentation/links.yo' for more -info. - -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 -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. - -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' - -bugs -==== - - 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. - -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. +Send bug reports to . For help and questions use +.