using a high level description file as input. LilyPond is part of the
GNU Project.
-versioning
+Versioning
==========
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 development versions 'y' is odd.
-requirements
-============
+ Version 1.4 is the latest stable release.
- For the compilation and running of LilyPond you need some additional
-packages. Please refer to the installation instructions.
+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 please refer to the installation
+instructions. These instructions can be found when you unpack lilypond,
+as `lilypond-x.y.z/INSTALL.txt'.
-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
-
-documentation
+Documentation
=============
- The real documentation is the directory Documentation/
+ The documentation is available online at `http://www.lilypond.org/'.
+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.
- 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.
+ * `.dvi', for the tutorial and reference manual. Do
- * use `.html'. Point your browser to
- `http://www.cs.uu.nl/~hanwen/lilypond/index.html'.
+ make -C Documentation/user/ dvi
+ The printable documentation is left in `Documentation/user/out/'.
- * use `.dvi', for the tutorial and reference manual. Do
+ * paper. Create the .dvi documentation, and print it with dvips.
- make -C Documentation/tex/ dvi
- * use ASCII. Do using
- make -C Documentation/
+Comments
+========
+ LilyPond is a long way from finished and polished, so please send
+your criticism, comments, bugreports, patches, etc., to the mailing
+list, _not_ to us personally.
-comments
-========
+ We have the following mailing lists:
+
+ * info-lilypond@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/info-lilypond) 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.
- LilyPond is a long way from finished and polished. We do appreciate
-criticism, comments, bugreports, patches, etc.
+ * lilypond-devel@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/lilypond-devel) For
+ discussions about developing lilypond, in particular the unstable
+ series.
- Please send your e-mail to one of the MAILING LISTS
+ * lilypond-user@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/lilypond-user) For
+ discussions about using lilypond, in particular the stable series.
- and _not_ to us personally. See `Documentation/links.yo' for more
-info.
+ * bug-lilypond@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/bug-lilypond) If you have
+ bugreports, you should send them to this list.
-windows 32
+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.
+(`LilyPond-*.zip'), it is advisable to also download the source package
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/), since it might contain more
+documentation
-caveats
+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
+ 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
+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 <bug-lilypond@gnu.org>. For help and questions
+use <help-lilypond@gnu.org> and <lilypond-discuss@gnu.org>. Please
+consult the FAQ and installation instructions before mailing your
+problems.