README.txt

   1
   2           This is the toplevel README to LilyPond
   3
   4 LilyPond is a music typesetter.  It produces beautiful sheet
   5 music using a high level description file as  input.   Lily-
   6 Pond is part of the GNU Project.
   7
   8 1: VERSIONING
   9
  10 LilyPond  uses a versioning scheme similar to the Linux ker-
  11 nel.  In a  version  "x.y.z",  an  even  second  number  'y'
  12 denotes  a  stable version.  For development versions 'y' is
  13 odd.  For using straightforward score production, please use
  14 the  latest  stable  version.   Development versions may not
  15 produce good or nice scores.
  16
  17 2: REQUIREMENTS
  18
  19 For the compilation and running of LilyPond  you  need  some
  20 additional  packages.   Please  refer  to  the  installation
  21 instructions.
  22
  23 NOTE: If you downloaded a binary  (.rpm  or  a  W95/NT  .zip
  24 file), then you don't have to compile LilyPond.
  25
  26 3: INSTALLATION
  27
  28 For  your  convenience,  a  formatted  copy  of  the INSTALL
  29 instructions are in the toplevel directory, as INSTALL.txt
  30
  31 The process is fairly straightforward, but chances are  that
  32 you  have  to specify directories for  to configure: this is
  33 done with the options --enable-tex-dir and --enable-mf-dir
  34
  35 4: DOCUMENTATION
  36
  37 The real documentation is the directory Documentation/
  38
  39 To generate the pretty-printed docs, you have to run config-
  40 ure first, and then do this:
  41
  42 make doc
  43
  44 You  can  also  simply read the .yo sources.  They are ASCII
  45 text.  The complete documentation is accessible in formatted
  46 form  at the website http://www.cs.uu.nl/people/hanwen/lily-
  47 pond/index.html
  48
  49 5: COMMENTS
  50
  51 LilyPond is a long way from finished and  polished.   We  do
  52 appreciate criticism, comments, bugreports, patches, etc.
  53
  54              Please send your e-mail to one of the MAILING LISTS
  55
  56 and  not  to  us personally.  See Documentation/links.yo for
  57 more info.
  58
  59 6: WINDOWS 32
  60
  61 If you have received this file as  part  of  a  DOS/Window32
  62 distribution  (LilyPond-*.zip), then it is advisable to also
  63 download the source package, since  it  might  contain  more
  64 documentation ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
  65
  66 If you decide to build LilyPond from source, please read the
  67 INSTALL.txt document first,  especially  the  Windows  NT/95
  68 section.
  69
  70 7: CAVEATS
  71
  72 * Please read the file BUGS for some ugly bugs.
  73
  74 *  If  you  have  installed  a  previous version, be sure to
  75 remove old font files, eg
  76
  77      rm `find /var/lib/texmf/fonts -name 'feta*'`
  78
  79 a script to  do  this  for  you  is  in  buildscripts/clean-
  80 fonts.sh
  81
  82 8: CDROM DISTRIBUTIONS
  83
  84 If  you  have received LilyPond on a cdrom, chances are that
  85 development has moved a some patchlevels up.   Please  check
  86 the latest version of LilyPond before reporting bugs.