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 The same goes for a version with a 4th version number, eg
  20
  21         1.2.3.mypatch2
  22
  23 It will be safer if you download 1.2.3 or wait for 1.2.4.
  24
  25 2: REQUIREMENTS
  26
  27 For the compilation and running of LilyPond you need some additional
  28 packages.  Please refer to the installation instructions.
  29
  30 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  31 you don't have to compile LilyPond.
  32
  33 3: INSTALLATION
  34
  35 For your convenience, a formatted copy of the INSTALL instructions are
  36 in the toplevel directory, as INSTALL.txt
  37
  38 The process is fairly straightforward, but chances are that you have
  39 to specify directories for TeX to configure: this is done with
  40 the options --enable-tex-dir and --enable-mf-dir
  41
  42 4: DOCUMENTATION
  43
  44 The real documentation is the directory Documentation/
  45
  46 To generate the pretty-printed docs, you have to run configure first,
  47 and then do this:
  48
  49         make doc
  50
  51 You can also simply read the .yo sources.  They are ASCII text.
  52 The complete documentation is accessible in formatted form at the
  53 website http://www.cs.uu.nl/people/hanwen/lilypond/index.html
  54
  55 5: COMMENTS
  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/links.yo for more info.
  63
  64 6: DOZE
  65
  66 If you have received this file as part of a DOS/Window32 distribution
  67 (lilypond-*.zip), then it is advisable to also download the source
  68 package, since it might contain more documentation
  69 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
  70
  71 If you decide to build LilyPond from source, please read the INSTALL.txt
  72 document first, especially the Windows NT/95 section.
  73
  74 7: CAVEATS
  75
  76 * Please read the file BUGS for some ugly bugs.  This especially applies
  77 Linux-Intel unix users.
  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 bin/cleanfonts.sh
  84
  85 8: CDROM DISTRIBUTIONS
  86
  87 If you have received LilyPond on a cdrom, chances are that development
  88 has moved a some patchlevels up.  If possible, please check the latest
  89 version of LilyPond before reporting bugs.