README

   1 This is the toplevel README to LilyPond         -*-Text-*-
   2
   3
   4 GNU LilyPond which converts music definition files into visual or
   5 audio output: it can typeset formatted sheet music in TeX and
   6 and (mechanical) perfomances to MIDI files.
   7
   8
   9 1. VERSIONING
  10
  11 if you have downloaded a
  12
  13         *.pre*
  14
  15 version, then this is version is *not* meant for producing nice output
  16 (but to keep your patchsets up to date). It might not even compile.
  17
  18
  19 2. REQUIREMENTS
  20
  21 For the compilation and running of LilyPond you need some additional
  22 packages. The most unusual one of this are the metafont sources to
  23 MusixTeX-fonts. Please refer to the installation instructions on how
  24 to obtain and install them.
  25
  26
  27 3. INSTALLATION
  28
  29 For your convenience, a formatted copy of the INSTALL instructions are
  30 in the toplevel directory, as INSTALL.text
  31
  32
  33 4. DOCUMENTATION
  34
  35 The real documentation is the directory Documentation/
  36
  37 To generate the pretty-printed docs, you have to run configure first,
  38 and then do this:
  39
  40         make doc
  41
  42 You can also simply read the .pod sources. They are ASCII text.
  43 .pod is the documentation format of perl (see perlpod(1))
  44
  45
  46 5. COMMENTS
  47
  48 LilyPond is a long way from finished and polished.  I do appreciate
  49 criticism, comments, bugreports, patches, etc.  Please send e-mail to
  50 the mailing lists.  See Documentation/links.pod for more info
  51
  52
  53 6. DOZE
  54
  55 If you have received this file as part of a DOS/Window32 distribution
  56 (lilypond-*.zip ), then it is advisable to also download the source
  57 package, since it might contain more documentation
  58
  59         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
  60         ftp://alpha.gnu.ai.mit.edu/gnu/lilypond/ (US)
  61
  62 The website also contains the complete documentation
  63
  64         http://www.stack.nl/~hanwen/lilypond/index.html
  65
  66
  67 7. CAVEATS
  68
  69 Please read the file BUGS for some ugly bugs.  This especially
  70 applies to Solaris 2.x and Linux-Intel unix users.