README.txt

   1
   2
   3    )
   4
   5 This is the toplevel README to LilyPond
   6 ***************************************
   7
   8    LilyPond is a music typesetter.  It produces beautiful sheet music
   9 using a high level description file as input.  LilyPond is part of the
  10 GNU Project.
  11
  12 versioning
  13 ==========
  14
  15    LilyPond uses a versioning scheme similar to the Linux kernel.  In a
  16 version "x.y.z", an even second number 'y' denotes a stable version.
  17 For development versions 'y' is odd.  For using straightforward score
  18 production, please use the latest stable version.  Development versions
  19 may not produce good or nice scores.
  20
  21 requirements
  22 ============
  23
  24    For the compilation and running of LilyPond you need some additional
  25 packages.  Please refer to the installation instructions.
  26
  27    NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  28 you don't have to compile LilyPond.
  29
  30 installation
  31 ============
  32
  33    For your convenience, a formatted copy of the INSTALL instructions
  34 are in the toplevel directory, as INSTALL.txt
  35
  36    The process is fairly straightforward, but chances are that you have
  37 to specify directories for TeX to `configure': this is done with the
  38 options `--enable-tex-dir' and `--enable-mf-dir'
  39
  40 documentation
  41 =============
  42
  43    The real documentation is the directory Documentation/
  44
  45    If you want to read the documentation online, these are options:
  46    * use `.html'. Refer to INSTALL.txt for info on how to make the
  47      .html documentation.
  48
  49    * use `.html'. Point your browser to
  50      `http://www.cs.uu.nl/~hanwen/lilypond/index.html'.
  51
  52    * use `.dvi',  for the tutorial and reference manual. Do
  53
  54             make -C Documentation/tex/ dvi
  55
  56    * use ASCII. Do using
  57
  58                 make -C Documentation/
  59
  60      The tutorial and the reference manual  can not be made in ASCII, as
  61      they contain graphics.
  62
  63 comments
  64 ========
  65
  66    LilyPond is a long way from finished and polished.  We do appreciate
  67 criticism, comments, bugreports, patches, etc.
  68
  69            Please send your e-mail to one of the MAILING LISTS
  70
  71    and _not_ to us personally.  See `Documentation/links.yo' for more
  72 info.
  73
  74 windows 32
  75 ==========
  76
  77    If you have received this file as part of a DOS/Window32 distribution
  78 (LilyPond-*.zip), then it is advisable to also download the source
  79 package, since it might contain more documentation
  80 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/'
  81
  82    If you decide to build LilyPond from source, please read the
  83 INSTALL.txt document first, especially the Windows NT/95 section.
  84
  85 caveats
  86 =======
  87
  88    * Please read the file BUGS for some ugly bugs.
  89
  90    * If you have installed a previous version, be sure to remove old
  91 font files, eg
  92      rm `find /var/lib/texmf/fonts -name 'feta*'`
  93
  94    a script to do this for you is in `buildscripts/clean-fonts.sh'
  95
  96 bugs
  97 ====
  98
  99    Send bug reports to bug-gnu-music@gnu.org.  For help and questions
 100 use help-gnu-music@gnu.org and gnu-music-discuss@gnu.org.  Please
 101 consult the faq before mailing your problems.
 102
 103 cdrom distributions
 104 ===================
 105
 106    if you have received LilyPond on a cdrom, chances are that
 107 development has moved a some patchlevels up.  Please check the latest
 108 version of LilyPond before reporting bugs.
 109