README.txt

   1
   2 TITLE INFORMATION: This is the toplevel README to LilyPond
   3
   4     LilyPond is the GNU Project music typesetter.  This program can print
   5 beautiful sheet music from a music definition file.  It can also play
   6 mechanical performances to a MIDI file.  Features include multiple
   7 staffs, meters, clefs, keys, lyrics, versatile input language, cadenzas,
   8 beams, slurs, triplets, named chords, transposing, formatting scores,
   9 part extraction.  It includes a nice font of musical symbols.
  10
  11 1: VERSIONING
  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 2: REQUIREMENTS
  20
  21 For the compilation and running of LilyPond you need some additional
  22 packages.  Please refer to the installation instructions.
  23
  24 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  25 you don't have to compile LilyPond.
  26
  27 3: INSTALLATION
  28
  29 For your convenience, a formatted copy of the INSTALL instructions are
  30 in the toplevel directory, as INSTALL.txt
  31
  32 The process is fairly straightforward, but chances are that you have
  33 to specify directories for TeX to configure: this is done with
  34 the options --enable-tex-dir and --enable-mf-dir
  35
  36 4: DOCUMENTATION
  37
  38 The real documentation is the directory Documentation/
  39
  40 To generate the pretty-printed docs, you have to run configure first,
  41 and then do this:
  42
  43         make doc
  44
  45 You can also simply read the .yo sources.  They are ASCII text.
  46 The complete documentation is accessible in formatted form at the
  47 website http://www.cs.uu.nl/people/hanwen/lilypond/index.html
  48
  49 5: COMMENTS
  50
  51 LilyPond is a long way from finished and polished.  We do appreciate
  52 criticism, comments, bugreports, patches, etc.
  53
  54            Please send your e-mail to one of the MAILING LISTS
  55
  56 and not to us personally.  See Documentation/links.yo for more info.
  57
  58 6: WINDOWS 32
  59
  60 If you have received this file as part of a DOS/Window32 distribution
  61 (LilyPond-*.zip), then it is advisable to also download the source
  62 package, since it might contain more documentation
  63 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
  64
  65 If you decide to build LilyPond from source, please read the INSTALL.txt
  66 document first, especially the Windows NT/95 section.
  67
  68 7: CAVEATS
  69
  70 * Please read the file BUGS for some ugly bugs.
  71
  72 * If you have installed a previous version, be sure to remove old font
  73 files, eg
  74 rm `find /var/lib/texmf/fonts -name 'feta*'`
  75
  76 a script to do this for you is in buildscripts/clean-fonts.sh
  77
  78 8: CDROM DISTRIBUTIONS
  79
  80 If you have received LilyPond on a cdrom, chances are that development
  81 has moved a some patchlevels up.  Please check the latest version of
  82 LilyPond before reporting bugs.