]> git.donarmstrong.com Git - lilypond.git/blobdiff - README.txt
release: 1.5.48
[lilypond.git] / README.txt
index 957e88819c50878247d6a003bfd76a14b1ef6ad0..6ee2dd75356c8aff38a1dd3b73d47a914d0c83fd 100644 (file)
@@ -12,66 +12,72 @@ 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
+===========
+
+   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), 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 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
-
-            make -C Documentation/user/ dvi
-
-   * use ASCII. Do using
-               make -C doc
+   * paper. Create the .dvi documentation, and print it with dvips.
 
 
 Comments
 ========
 
-   LilyPond is a long way from finished and polished.  We do appreciate
-criticism, comments, bugreports, patches, etc., but please,
+   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.
+
+   We have the following mailing lists:
 
-          Please send your e-mail to one of the 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.
 
-   and _not_ to us personally.  See `Documentation/mail.texi' for more
-info.
+   * lilypond-devel@gnu.org
+     (http://mail.gnu.org/mailman/listinfo/lilypond-devel)   For
+     discussions about developing lilypond, in particular the unstable
+     series.
+
+   * lilypond-user@gnu.org
+     (http://mail.gnu.org/mailman/listinfo/lilypond-user)   For
+     discussions about using lilypond, in particular the stable series.
+
+   * 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
 ==========
 
    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/'
-
-   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
 =======
@@ -80,20 +86,12 @@ Caveats
 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/out/clean-fonts'
 
 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 and installation instructions before mailing your
-problems.
-
-CDROM distributions
-===================
-
-   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 <bug-lilypond@gnu.org>.  For help and questions
+use <lilypond-user@gnu.org>.  Please consult the FAQ and installation
+instructions before mailing your problems.