X-Git-Url: https://git.donarmstrong.com/lilypond.git?a=blobdiff_plain;f=README.txt;h=6b35be73f5183bb933e75c9b03900877502336de;hb=refs%2Fheads%2Fdebian;hp=17ffb51f4d2cb48ba7aa21be78675fa193f6d63c;hpb=82731e802565546441c401a84a13b486e54eb760;p=lilypond.git diff --git a/README.txt b/README.txt index 17ffb51f4d..6b35be73f5 100644 --- a/README.txt +++ b/README.txt @@ -1,101 +1,78 @@ +Toplevel README +*************** +1 Toplevel README +***************** -This is the toplevel README to LilyPond -*************************************** +LilyPond is a music typesetter. It produces beautiful sheet music +using a description file as input. LilyPond is part of the GNU Project. - 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. +1.1 Versioning +============== -Versioning -========== +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. - 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. +1.2 Downloading +=============== -Requirements -============ - - 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), you -don't have to compile LilyPond. - -Installation -============ - - For your convenience, a formatted copy of the INSTALL instructions -are in the toplevel directory, as INSTALL.txt - -Documentation -============= - - The real documentation is the directory Documentation/ +The primary download site for sourcecode is +`http://lilypond.org/download/'. - 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. +1.3 Compilation +=============== - * use HTML. Point your browser to - `http://www.cs.uu.nl/~hanwen/lilypond/index.html'. +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'. - * use `.dvi', for the tutorial and reference manual. Do +1.4 Documentation +================= - make -C Documentation/user/ dvi +The documentation is available online at `http://lilypond.org/doc/'. - You need a working LilyPond binary to create the DVI sources . + You can also build it locally: follow the instructions under +`Building documentation' in the installation instructions. - * use ASCII. Do using - make -C doc - - -Comments -======== - - LilyPond is a long way from finished and polished. We do appreciate -criticism, comments, bugreports, patches, etc., but please, - - Please send your e-mail to one of the MAILING LISTS - - and _not_ to us personally. See `Documentation/mail.texi' for more -info. +1.5 Comments +============ -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'), it is advisable to also download the source -package, since it might contain more documentation -`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/' + We have the following mailing lists: - If you decide to build LilyPond from source, please read the -INSTALL.txt document first, especially the Windows NT/95 section. + * 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. -Caveats -======= + * lilypond-devel@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-devel) for + discussions about developing LilyPond, in particular the unstable + series. - If you have installed a previous version, be sure to remove old font -files, eg., - rm `find /var/lib/texmf/fonts -name 'feta*'` + * lilypond-user@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-user) for + discussions about using LilyPond, in particular the stable series. - a script to do this for you is in `buildscripts/clean-fonts.sh' + * bug-lilypond@gnu.org + (http://lists.gnu.org/mailman/listinfo/bug-lilypond) for sending + bugreports. -Bugs -==== + * lilypond-cvs@gnu.org + (http://lists.gnu.org/mailman/listinfo/lilypond-cvs) for log + files from the autobuild. - Send bug reports to . For help and questions -use and . Please -consult the FAQ and installation instructions before mailing your -problems. + You can search the lists from our searching facilities +(http://lilypond.org/search). -CDROM distributions -=================== +1.6 Bugs +======== - 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. +Send bug reports to . For help and questions use +.