README.txt

   1
   2 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, formatting scores, part extraction.  It includes
   9 a nice font of musical symbols.
  10
  11 1: VERSIONING
  12
  13 if you have downloaded a
  14
  15         *.pre*
  16
  17 version, then this is version is *not* meant for producing nice output
  18 (but to keep your patchsets up to date).  It might not even compile.
  19
  20 2: REQUIREMENTS
  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), then
  26 you don't have to compile LilyPond.
  27
  28 3: INSTALLATION
  29
  30 For your convenience, a formatted copy of the INSTALL instructions are
  31 in the toplevel directory, as INSTALL.txt
  32
  33 The process is fairly straightforward, but chances are that you have
  34 to specify directories for TeX to configure (--enable-tex-dir,
  35 --enable-mf-dir)
  36
  37 4: DOCUMENTATION
  38
  39 The real documentation is the directory Documentation/
  40
  41 To generate the pretty-printed docs, you have to run configure first,
  42 and then do this:
  43
  44         make doc
  45
  46 You can also simply read the .yo sources.  They are ASCII text.
  47 The complete documentation is accessible in formatted form at the
  48 website
  49
  50         http://www.cs.uu.nl/people/hanwen/lilypond/index.html
  51
  52 5: COMMENTS
  53
  54 LilyPond is a long way from finished and polished.  We do appreciate
  55 criticism, comments, bugreports, patches, etc.
  56
  57            Please send your e-mail to one of the MAILING LISTS
  58
  59 and not to us personally.  See Documentation/links.yo for more info.
  60
  61 6: DOZE
  62
  63 If you have received this file as part of a DOS/Window32 distribution
  64 (lilypond-*.zip), then it is advisable to also download the source
  65 package, since it might contain more documentation
  66
  67         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
  68
  69 If you decide to build LilyPond from source, please read the INSTALL.txt
  70 document first, especially the Windows NT/95 section.
  71
  72 7: CAVEATS
  73
  74 * Please read the file BUGS for some ugly bugs.  This especially applies
  75 Linux-Intel unix users.
  76
  77 * If you have installed a previous version, be sure to remove old font
  78 files, eg
  79
  80         rm `find /var/lib/texmf/fonts -name 'feta*'`
  81
  82 a script to do this for you is in bin/cleanfonts.sh
  83
  84 8: CDROM DISTRIBUTIONS
  85
  86 If you have received LilyPond on a cdrom, chances are that development
  87 has moved a some patchlevels up.  If possible, please check the latest
  88 version of LilyPond before reporting bugs.