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 info 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    * use ASCII. Do using
  51                 make -C doc
  52
  53
  54 Comments
  55 ========
  56
  57    LilyPond is a long way from finished and polished.  We do appreciate
  58 criticism, comments, bugreports, patches, etc.
  59
  60            Please send your e-mail to one of the MAILING LISTS
  61
  62    and _not_ to us personally.  See `Documentation/mail.texi' for more
  63 info.
  64
  65 Windows 32
  66 ==========
  67
  68    If you have received this file as part of a DOS/Window32 distribution
  69 (`LilyPond-*.zip'), it is advisable to also download the source
  70 package, since it might contain more documentation
  71 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/'
  72
  73    If you decide to build LilyPond from source, please read the
  74 INSTALL.txt document first, especially the Windows NT/95 section.
  75
  76 Caveats
  77 =======
  78
  79    If you have installed a previous version, be sure to remove old font
  80 files, eg.,
  81      rm `find /var/lib/texmf/fonts -name 'feta*'`
  82
  83    a script to do this for you is in `buildscripts/clean-fonts.sh'
  84
  85 Bugs
  86 ====
  87
  88    Send bug reports to <bug-gnu-music@gnu.org>.  For help and questions
  89 use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>.  Please
  90 consult the FAQ and installation instructions before mailing your
  91 problems.
  92
  93 CDROM distributions
  94 ===================
  95
  96    If you have received LilyPond on a cdrom, chances are that
  97 development has moved some patchlevels up.  Please check the latest
  98 version of LilyPond before reporting bugs.
  99