README

   1 This is the toplevel README to LilyPond         -*-Text-*-
   2
   3
   4 LilyPond is the GNU Project music typesetter.  The program generates
   5 visual or auditive output from a music definition file: it can typeset
   6 formatted sheet music to a TeX file and play (mechanical) performances
   7 to a MIDI file.  Features include multiple staffs, meters, clefs,
   8 keys, lyrics, versatile input-language, cadenzas, beams, slurs,
   9 triplets.
  10
  11
  12 1. VERSIONING
  13
  14 if you have downloaded a
  15
  16         *.pre*
  17
  18 version, then this is version is *not* meant for producing nice output
  19 (but to keep your patchsets up to date). It might not even compile.
  20
  21
  22 2. REQUIREMENTS
  23
  24 For the compilation and running of LilyPond you need some additional
  25 packages. Please refer to the installation instructions.
  26
  27
  28 3. INSTALLATION
  29
  30 For your convenience, a formatted copy of the INSTALL instructions are
  31 in the toplevel directory, as INSTALL.text
  32
  33
  34 4. DOCUMENTATION
  35
  36 The real documentation is the directory Documentation/
  37
  38 To generate the pretty-printed docs, you have to run configure first,
  39 and then do this:
  40
  41         make doc
  42
  43 You can also simply read the .pod sources. They are ASCII text.
  44 .pod is the documentation format of perl (see perlpod(1))
  45
  46
  47 5. COMMENTS
  48
  49 LilyPond is a long way from finished and polished.  I do appreciate
  50 criticism, comments, bugreports, patches, etc.  Please send e-mail to
  51 the mailing lists.  See Documentation/links.pod for more info
  52
  53
  54 6. DOZE
  55
  56 If you have received this file as part of a DOS/Window32 distribution
  57 (lilypond-*.zip), then it is advisable to also download the source
  58 package, since it might contain more documentation
  59
  60         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
  61         ftp://alpha.gnu.org/gnu/lilypond/ (US)
  62
  63 The website also contains the complete documentation
  64
  65         http://www.stack.nl/~hanwen/lilypond/index.html
  66
  67 If you decide to build LilyPond from source, please read the INSTALL
  68 document first, especially the Windows NT/95 section.
  69
  70
  71 7. CAVEATS
  72
  73 * Please read the file BUGS for some ugly bugs.  This especially applies
  74 Linux-Intel unix users.
  75
  76 * If you have installed a previous version, be sure to remove old font
  77 files, eg
  78
  79         rm `find /var/lib/texmf/fonts -name 'feta*'`
  80
  81 a script to do this for you is in bin/cleanfonts.sh