-This is the toplevel README to LilyPond
-
- LilyPond is the GNU Project music typesetter. This program can print
-beautiful sheet music from a music definition file. It can also play
-mechanical performances to a MIDI file. Features include multiple
-staffs, meters, clefs, keys, lyrics, versatile input language, cadenzas,
-beams, slurs, triplets, formatting scores, part extraction. It includes
-a nice font of musical symbols.
-1: VERSIONING
-
-if you have downloaded a
+This is the toplevel README to LilyPond
+***************************************
- *.pre*
+ 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.
-version, then this is version is *not* meant for producing nice output
-(but to keep your patchsets up to date). It might not even compile.
-The same goes for a version with a 4th version number, eg
+Versioning
+==========
- 1.2.3.mypatch2
+ 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.
-It will be safer if you download 1.2.3 or wait for 1.2.4.
+ Version 1.4 is the latest stable release.
-2: REQUIREMENTS
+Compilation
+===========
-For the compilation and running of LilyPond you need some additional
-packages. Please refer to the installation instructions.
+ 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'.
-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.
-3: INSTALLATION
+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://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.
-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
+ * `.dvi', for the tutorial and reference manual. Do
-4: DOCUMENTATION
+ make -C Documentation/user/ dvi
+ The printable documentation is left in `Documentation/user/out/'.
-The real documentation is the directory Documentation/
+ * paper. Create the .dvi documentation, and print it with dvips.
-To generate the pretty-printed docs, you have to run configure first,
-and then do this:
- make doc
+Comments
+========
-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/lilypond/index.html
+ 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.
-5: COMMENTS
+ We have the following mailing lists:
-LilyPond is a long way from finished and polished. We do appreciate
-criticism, comments, bugreports, patches, etc.
+ * 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.
- Please send your e-mail to one of the MAILING LISTS
+ * lilypond-devel@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/lilypond-devel) For
+ discussions about developing lilypond, in particular the unstable
+ series.
-and not to us personally. See Documentation/links.yo for more info.
+ * lilypond-user@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/lilypond-user) For
+ discussions about using lilypond, in particular the stable series.
-6: DOZE
+ * bug-lilypond@gnu.org
+ (http://mail.gnu.org/mailman/listinfo/bug-lilypond) If you have
+ bugreports, you should send them to this list.
-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/
+Windows 32
+==========
-If you decide to build LilyPond from source, please read the INSTALL.txt
-document first, especially the Windows NT/95 section.
+ If you have received this file as part of a DOS/Window32 distribution
+(`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
-7: CAVEATS
+Caveats
+=======
-* Please read the file BUGS for some ugly bugs. This especially applies
-Linux-Intel unix users.
+ If you have installed a previous version, be sure to remove old font
+files, eg.,
+ rm `find /var/lib/texmf/fonts -name 'feta*'`
-* 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 bin/cleanfonts.sh
+Bugs
+====
-8: CDROM DISTRIBUTIONS
+ Send bug reports to <bug-lilypond@gnu.org>. For help and questions
+use <lilypond-user@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. If possible, please check the latest
-version of LilyPond before reporting bugs.
projects / lilypond.git / blobdiff