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
  43 `http://www.cs.uu.nl/~hanwen/lilypond/index.html'.  You can also build
  44 it locally. This does require a working LilyPond binary.  The following
  45 formats are supported:
  46    * HTML. Refer to INSTALL.txt for information on how to make the HTML
  47      documentation.
  48
  49    * `.dvi',  for the tutorial and reference manual. Do
  50
  51            make -C Documentation/user/ dvi
  52      The printable documentation is left in `Documentation/user/out/'.
  53
  54    * paper. Create the .dvi documentation, and print it with dvips.
  55
  56
  57 Comments
  58 ========
  59
  60    LilyPond is a long way from finished and polished, so we please send
  61 your criticism, comments, bugreports, patches, etc., to the mailing
  62 list.  and _not_ to us personally.
  63
  64    We have the following mailing lists:
  65
  66    * info-gnu-music@gnu.org
  67      (http://mail.gnu.org/mailman/listinfo/info-gnu-music) is a
  68      low-volume list for information on the GNU Music project.
  69      This list is moderated; ask     David R. Linn <drl@gnu.org> or
  70      Han-Wen <hanwen@cs.uu.nl> to send announcements for this list.
  71
  72    * gnu-music-discuss@gnu.org
  73      (http://mail.gnu.org/mailman/listinfo/gnu-music-discuss)   For
  74      general discussions concerning LilyPond.
  75
  76    * help-gnu-music@gnu.org
  77      (http://mail.gnu.org/mailman/listinfo/help-gnu-music)     For help
  78      with using LilyPond.
  79
  80    * bug-gnu-music@gnu.org
  81      (http://mail.gnu.org/mailman/listinfo/bug-gnu-music) If you have
  82      bugreports, you should send them to this list.
  83
  84 Windows 32
  85 ==========
  86
  87    If you have received this file as part of a DOS/Window32 distribution
  88 (`LilyPond-*.zip'), it is advisable to also download the source
  89 package, since it might contain more documentation
  90 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/'
  91
  92 Caveats
  93 =======
  94
  95    If you have installed a previous version, be sure to remove old font
  96 files, eg.,
  97      rm `find /var/lib/texmf/fonts -name 'feta*'`
  98
  99    a script to do this for you is in `buildscripts/clean-fonts.sh'
 100
 101 Bugs
 102 ====
 103
 104    Send bug reports to <bug-gnu-music@gnu.org>.  For help and questions
 105 use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>.  Please
 106 consult the FAQ and installation instructions before mailing your
 107 problems.
 108