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.  For using straightforward score
  16 production, please use the latest stable version.  Development versions
  17 may not produce good or nice scores.
  18
  19 Requirements
  20 ============
  21
  22    For the compilation and running of LilyPond you need some additional
  23 packages.  Please refer to the installation instructions.
  24
  25    NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
  26 don't have to compile LilyPond.
  27
  28 Installation
  29 ============
  30
  31    For your convenience, a formatted copy of the INSTALL instructions
  32 are in the toplevel directory, as INSTALL.txt
  33
  34 Documentation
  35 =============
  36
  37    The real documentation is the directory Documentation/
  38
  39    If you want to read the documentation online, these are options:
  40    * use HTML. Refer to INSTALL.txt for information on how to make the
  41      HTML documentation.
  42
  43    * use HTML. Point your browser to
  44      `http://www.cs.uu.nl/~hanwen/lilypond/index.html'.
  45
  46    * use `.dvi',  for the tutorial and reference manual. Do
  47
  48             make -C Documentation/user/ dvi
  49
  50      You need a working LilyPond binary to create the DVI sources  .
  51
  52    * use ASCII. Do using
  53                 make -C doc
  54
  55
  56 Comments
  57 ========
  58
  59    LilyPond is a long way from finished and polished.  We do appreciate
  60 criticism, comments, bugreports, patches, etc., but please,
  61
  62            Please send your e-mail to one of the MAILING LISTS
  63
  64    and _not_ to us personally.  See `Documentation/mail.texi' for more
  65 info.
  66
  67 Windows 32
  68 ==========
  69
  70    If you have received this file as part of a DOS/Window32 distribution
  71 (`LilyPond-*.zip'), it is advisable to also download the source
  72 package, since it might contain more documentation
  73 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/'
  74
  75    If you decide to build LilyPond from source, please read the
  76 INSTALL.txt document first, especially the Windows NT/95 section.
  77
  78 Caveats
  79 =======
  80
  81    If you have installed a previous version, be sure to remove old font
  82 files, eg.,
  83      rm `find /var/lib/texmf/fonts -name 'feta*'`
  84
  85    a script to do this for you is in `buildscripts/clean-fonts.sh'
  86
  87 Bugs
  88 ====
  89
  90    Send bug reports to <bug-gnu-music@gnu.org>.  For help and questions
  91 use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>.  Please
  92 consult the FAQ and installation instructions before mailing your
  93 problems.
  94
  95 CDROM distributions
  96 ===================
  97
  98    If you have received LilyPond on a cdrom, chances are that
  99 development has moved some patchlevels up.  Please check the latest
 100 version of LilyPond before reporting bugs.
 101