README.txt

   1
   2
   3
   4
   5
   6
   7 This  is the toplevel README to LilyPond LilyPond is the GNU
   8 Project music typesetter.  This program can print  beautiful
   9 sheet  music from a music definition file.  It can also play
  10 mechanical performances to a MIDI  file.   Features  include
  11 multiple  staffs,  meters,  clefs,  keys,  lyrics, versatile
  12 input language, cadenzas, beams, slurs, triplets, formatting
  13 scores, part extraction.  It includes a nice font of musical
  14 symbols.
  15
  16 1: VERSIONING
  17
  18      if you have downloaded a *.pre* version, then  this  is
  19 version  is  *not*  meant  for producing nice output (but to
  20 keep your patchsets up to date).  It might not even compile.
  21 The  same  goes  for a version with a 4th version number, eg
  22 1.2.3.mypatch2 It will be safer if  you  download  1.2.3  or
  23 wait for 1.2.4.
  24
  25 2: REQUIREMENTS
  26
  27      For  the  compilation  and running of LilyPond you need
  28 some additional packages.  Please refer to the  installation
  29 instructions.   NOTE:  If you downloaded a binary (.rpm or a
  30 W95/NT .zip file), then you don't have to compile  LilyPond.
  31
  32 3: INSTALLATION
  33
  34      For  your  convenience, a formatted copy of the INSTALL
  35 instructions are in the toplevel directory,  as  INSTALL.txt
  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 To generate the pretty-printed docs, you have to run config-
  44 ure  first,  and  then do this: make doc You can also simply
  45 read the .yo sources.  They are ASCII  text.   The  complete
  46 documentation is accessible in formatted form at the website
  47 http://www.cs.uu.nl/people/hanwen/lilypond/index.html
  48
  49 5: COMMENTS
  50
  51      LilyPond is a long way from finished and polished.   We
  52 do appreciate criticism, comments, bugreports, patches, etc.
  53 Please send your e-mail to one of the MAILING LISTS and  not
  54 to us personally.  See Documentation/links.yo for more info.
  55
  56 6: WINDOWS 32
  57
  58      If you have received this file as part  of  a  DOS/Win-
  59 dow32 distribution (lilypond-*.zip), then it is advisable to
  60 also download the source package,  since  it  might  contain
  61
  62
  63 more  documentation  ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/ If
  64 you decide to build LilyPond from source,  please  read  the
  65 INSTALL.txt  document  first,  especially  the Windows NT/95
  66 section.
  67
  68 7: CAVEATS
  69
  70      * Please read the file BUGS for some ugly  bugs.   This
  71 especially  applies  Linux-Intel  unix users.  * If you have
  72 installed a previous version, be sure  to  remove  old  font
  73 files, eg
  74
  75
  76
  77
  78      rm `find /var/lib/texmf/fonts -name 'feta*'`
  79
  80
  81
  82
  83 a script to do this for you is in bin/cleanfonts.sh
  84
  85
  86 8: CDROM DISTRIBUTIONS
  87
  88
  89 If  you  have received LilyPond on a cdrom, chances are that
  90 development has moved a some patchlevels up.   If  possible,
  91 please check the latest version of LilyPond before reporting
  92 bugs.