- 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. So, in theory, version 1.2 is
+stable, which means that there are no glaring errors in it. In practice
+1.2.x is also unmaintained.
-For the compilation and running of LilyPond you need some
-additional packages. Please refer to the installation
-instructions.
+ 1.3.x is in healthy development: lots of problems turn up, but
+they're fixed quickly. Therefore we recommend you try 1.2.x, if you
+have any problem with it, upgrade to the latest 1.3.x release.
-NOTE: If you downloaded a binary (.rpm or a W95/NT .zip
-file), then you don't have to compile LilyPond.
+Requirements
+============
-3: INSTALLATION
+ For the compilation and running of LilyPond you need some additional
+packages. Please refer to the installation instructions in
+`INSTALL.txt'.
-For your convenience, a formatted copy of the INSTALL
-instructions are in the toplevel directory, as INSTALL.txt
+ NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
+don't have to compile LilyPond.
-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
+Installation
+============
-4: DOCUMENTATION
+ For your convenience, a formatted copy of the INSTALL instructions
+are in the toplevel directory, as INSTALL.txt
-The real documentation is the directory Documentation/
+Documentation
+=============
-To generate the pretty-printed docs, you have to run config-
-ure first, and then do this:
+ The documentation is available online at
+`http://www.cs.uu.nl/~hanwen/lilypond/index.html'. You can also build
+it locally. This does require a working LilyPond binary. The following
+formats are supported:
+ * HTML. Refer to INSTALL.txt for information on how to make the HTML
+ documentation.
-make doc
+ * `.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 http://www.cs.uu.nl/people/hanwen/lily-
-pond/index.html
+ make -C Documentation/user/ dvi
+ The printable documentation is left in `Documentation/user/out/'.
-5: COMMENTS
+ * paper. Create the .dvi documentation, and print it with dvips.
-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
+Comments
+========
-and not to us personally. See Documentation/links.yo for
-more info.
+ LilyPond is a long way from finished and polished, so we please send
+your criticism, comments, bugreports, patches, etc., to the mailing
+list. and _not_ to us personally.
-6: WINDOWS 32
+ We have the following mailing lists:
-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/
+ * info-gnu-music@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/info-gnu-music) is a
+ low-volume list for information on the GNU Music project.
+ This list is moderated; ask David R. Linn <drl@gnu.org> or
+ Han-Wen <hanwen@cs.uu.nl> to send announcements for this list.
-If you decide to build LilyPond from source, please read the
-INSTALL.txt document first, especially the Windows NT/95
-section.
+ * gnu-music-discuss@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/gnu-music-discuss) For
+ general discussions concerning LilyPond.
-7: CAVEATS
+ * help-gnu-music@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/help-gnu-music) For help
+ with using LilyPond.
-* Please read the file BUGS for some ugly bugs.
+ * bug-gnu-music@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/bug-gnu-music) If you have
+ bugreports, you should send them to this list.
-* If you have installed a previous version, be sure to
-remove old font files, eg
+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/'
+
+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'
+
+Bugs
+====
-8: CDROM DISTRIBUTIONS
+ 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 and installation instructions before mailing your
+problems.
-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.
projects / lilypond.git / blobdiff