README.txt

   1
   2
   3 This is the toplevel README to LilyPond
   4 ***************************************
   5
   6    LilyPond is a music typesetter.  It produces beautiful sheet music
   7 using a high level description file as input.  LilyPond is part of the
   8 GNU Project.
   9
  10 Versioning
  11 ==========
  12
  13    LilyPond uses a versioning scheme similar to the Linux kernel.  In a
  14 version "x.y.z", an even second number 'y' denotes a stable version.
  15 For development versions 'y' is odd.  So, in theory, version 1.2 is
  16 stable, which means that there are no glaring errors in it. In practice
  17 1.2.x is also unmaintained.
  18
  19    1.3.x is in healthy development: lots of problems turn up, but
  20 they're fixed quickly. Therefore we recommend you try 1.2.x, if you
  21 have any problem with it, upgrade to the latest 1.3.x release.
  22
  23 Requirements
  24 ============
  25
  26    For the compilation and running of LilyPond you need some additional
  27 packages.  Please refer to the installation instructions in
  28 `INSTALL.txt'.
  29
  30    NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
  31 don't have to compile LilyPond.
  32
  33 Installation
  34 ============
  35
  36    For your convenience, a formatted copy of the INSTALL instructions
  37 are in the toplevel directory, as INSTALL.txt
  38
  39 Documentation
  40 =============
  41
  42    The documentation is available online at `http://www.lilypond.org/'.
  43 You can also build it locally. This does require a working LilyPond
  44 binary.  The following formats are supported:
  45    * HTML. Refer to INSTALL.txt for information on how to make the HTML
  46      documentation.
  47
  48    * `.dvi',  for the tutorial and reference manual. Do
  49
  50            make -C Documentation/user/ dvi
  51      The printable documentation is left in `Documentation/user/out/'.
  52
  53    * paper. Create the .dvi documentation, and print it with dvips.
  54
  55
  56 Comments
  57 ========
  58
  59    LilyPond is a long way from finished and polished, so we please send
  60 your criticism, comments, bugreports, patches, etc., to the mailing
  61 list.  and _not_ to us personally.
  62
  63    We have the following mailing lists:
  64
  65    * info-gnu-music@gnu.org
  66      (http://mail.gnu.org/mailman/listinfo/info-gnu-music) is a
  67      low-volume list for information on the GNU Music project.
  68      This list is moderated; ask     David R. Linn <drl@gnu.org> or
  69      Han-Wen <hanwen@cs.uu.nl> to send announcements for this list.
  70
  71    * gnu-music-discuss@gnu.org
  72      (http://mail.gnu.org/mailman/listinfo/gnu-music-discuss)   For
  73      general discussions concerning LilyPond.
  74
  75    * help-gnu-music@gnu.org
  76      (http://mail.gnu.org/mailman/listinfo/help-gnu-music)     For help
  77      with using LilyPond.
  78
  79    * bug-gnu-music@gnu.org
  80      (http://mail.gnu.org/mailman/listinfo/bug-gnu-music) If you have
  81      bugreports, you should send them to this list.
  82
  83 Windows 32
  84 ==========
  85
  86    If you have received this file as part of a DOS/Window32 distribution
  87 (`LilyPond-*.zip'), it is advisable to also download the source package
  88 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/), since it might contain more
  89 documentation
  90
  91 Caveats
  92 =======
  93
  94    If you have installed a previous version, be sure to remove old font
  95 files, eg.,
  96      rm `find /var/lib/texmf/fonts -name 'feta*'`
  97
  98    a script to do this for you is in `buildscripts/clean-fonts.sh'
  99
 100 Bugs
 101 ====
 102
 103    Send bug reports to <bug-gnu-music@gnu.org>.  For help and questions
 104 use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>.  Please
 105 consult the FAQ and installation instructions before mailing your
 106 problems.
 107