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. Sh, 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.
-requirements
+ 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.
+
+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), then
-you don't have to compile LilyPond.
+ NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
+don't have to compile LilyPond.
-installation
+Installation
============
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/
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.
+ * use HTML. Refer to INSTALL.txt for information on how to make the
+ HTML documentation.
- * use `.html'. Point your browser to
+ * use HTML. Point your browser to
`http://www.cs.uu.nl/~hanwen/lilypond/index.html'.
* use `.dvi', for the tutorial and reference manual. Do
- make -C Documentation/tex/ dvi
+ make -C Documentation/user/ dvi
+
+ You need a working LilyPond binary to create the DVI and HTML
+ sources.
* use ASCII. Do using
- make -C Documentation/
+ make doc
-comments
+Comments
========
LilyPond is a long way from finished and polished. We do appreciate
-criticism, comments, bugreports, patches, etc.
+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/links.yo' for more
-info.
+ and _not_ to us personally. We have the following mailing lists:
+
+ * 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.
-windows 32
+ * help-gnu-music@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/help-gnu-music) For help
+ with using LilyPond.
+
+ * 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.
+
+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
+(`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 decide to build LilyPond from source, please read the
INSTALL.txt document first, especially the Windows NT/95 section.
-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.
+use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>. Please
+consult the FAQ and installation instructions before mailing your
+problems.
-cdrom distributions
+CDROM distributions
===================
- if you have received LilyPond on a cdrom, chances are that
-development has moved a some patchlevels up. Please check the latest
+ 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.
projects / lilypond.git / blobdiff