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 If you want to read the documentation online, these are
  40 options:
  41
  42 o    use .html. Refer to INSTALL.txt for info on how to make
  43      the .html documentation.
  44
  45 o    use .html. Point your browser to
  46      http://www.cs.uu.nl/~hanwen/lilypond/index.html.
  47
  48 o     use .dvi,  for the tutorial and reference manual. Do
  49
  50             make -C Documentation/tex/ dvi
  51
  52 o    use ASCII. Do using
  53
  54                make -C Documentation/
  55
  56      The tutorial and the reference manual  can not be made
  57      in ASCII, as they contain graphics.
  58
  59 5: COMMENTS
  60
  61 LilyPond is a long way from finished and polished.  We do
  62 appreciate criticism, comments, bugreports, patches, etc.
  63
  64              Please send your e-mail to one of the MAILING LISTS
  65
  66 and not to us personally.  See Documentation/links.yo for
  67 more info.
  68
  69 6: WINDOWS 32
  70
  71 If you have received this file as part of a DOS/Window32
  72 distribution (LilyPond-*.zip), then it is advisable to also
  73 download the source package, since it might contain more
  74 documentation ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
  75
  76 If you decide to build LilyPond from source, please read the
  77 INSTALL.txt document first, especially the Windows NT/95
  78 section.
  79
  80 7: CAVEATS
  81
  82 * Please read the file BUGS for some ugly bugs.
  83
  84 * If you have installed a previous version, be sure to
  85 remove old font files, eg
  86
  87      rm `find /var/lib/texmf/fonts -name 'feta*'`
  88
  89 a script to do this for you is in buildscripts/clean-
  90 fonts.sh
  91
  92 8: BUGS
  93
  94 Send bug reports to bug-gnu-music@gnu.org.  For help and
  95 questions use help-gnu-music@gnu.org and gnu-music-dis-
  96 cuss@gnu.org.  Please consult the faq before mailing your
  97 problems.
  98
  99 9: CDROM DISTRIBUTIONS
 100
 101 If you have received LilyPond on a cdrom, chances are that
 102 development has moved a some patchlevels up.  Please check
 103 the latest version of LilyPond before reporting bugs.