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 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), then
  28 you don't have to compile LilyPond.
  29
  30
  31 3. INSTALLATION
  32
  33 For your convenience, a formatted copy of the INSTALL instructions are
  34 in the toplevel directory, as INSTALL.text
  35
  36 The process is fairly straightforward, but chances are that you have
  37 to specify directories for TeX to configure (--enable-tex-dir,
  38 --enable-mf-dir)
  39
  40 4. DOCUMENTATION
  41
  42 The real documentation is the directory Documentation/
  43
  44 To generate the pretty-printed docs, you have to run configure first,
  45 and then do this:
  46
  47         make doc
  48
  49 You can also simply read the .pod sources. They are ASCII text.
  50 .pod is the documentation format of perl (see perlpod(1))
  51
  52
  53 5. COMMENTS
  54
  55 LilyPond is a long way from finished and polished.  We do appreciate
  56 criticism, comments, bugreports, patches, etc.
  57
  58            Please send your e-mail to one of the MAILING LISTS
  59
  60 (and not to us personally). See Documentation/links.pod for more info
  61
  62
  63 6. DOZE
  64
  65 If you have received this file as part of a DOS/Window32 distribution
  66 (lilypond-*.zip), then it is advisable to also download the source
  67 package, since it might contain more documentation
  68
  69         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
  70
  71 The website also contains the complete documentation
  72
  73         http://www.cs.uu.nl/~hanwen/lilypond/index.html
  74
  75 If you decide to build LilyPond from source, please read the INSTALL
  76 document first, especially the Windows NT/95 section.
  77
  78
  79 7. CAVEATS
  80
  81 * Please read the file BUGS for some ugly bugs.  This especially applies
  82 Linux-Intel unix users.
  83
  84 * If you have installed a previous version, be sure to remove old font
  85 files, eg
  86
  87         rm `find /var/lib/texmf/fonts -name 'feta*'`
  88
  89 a script to do this for you is in bin/cleanfonts.sh