README.txt

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