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 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 .pod sources. They are ASCII text.
  47 .pod is the documentation format of perl (see perlpod(1))
  48
  49
  50 5. COMMENTS
  51
  52 LilyPond is a long way from finished and polished.  I do appreciate
  53 criticism, comments, bugreports, patches, etc.  Please send e-mail to
  54 the mailing lists.  See Documentation/links.pod for more info
  55
  56
  57 6. DOZE
  58
  59 If you have received this file as part of a DOS/Window32 distribution
  60 (lilypond-*.zip), then it is advisable to also download the source
  61 package, since it might contain more documentation
  62
  63         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
  64         ftp://alpha.gnu.org/gnu/lilypond/ (US)
  65
  66 The website also contains the complete documentation
  67
  68         http://www.stack.nl/~hanwen/lilypond/index.html
  69
  70 If you decide to build LilyPond from source, please read the INSTALL
  71 document first, especially the Windows NT/95 section.
  72
  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
  82         rm `find /var/lib/texmf/fonts -name 'feta*'`
  83
  84 a script to do this for you is in bin/cleanfonts.sh