README.txt

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