Documentation/topdocs/README.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename README.info
   3 @settitle This is the toplevel README to LilyPond
   4 @node Top, , ,
   5 @top
   6
   7 @chapter This is the toplevel README to LilyPond
   8
   9
  10 LilyPond is a music typesetter.  It produces beautiful sheet music
  11 using a high level description file as input.  LilyPond is part of
  12 the GNU Project.
  13
  14 @section Versioning
  15
  16 LilyPond uses a versioning scheme similar to the Linux kernel.  In a
  17 version "x.y.z", an even second number 'y' denotes a stable version.
  18 For development versions 'y' is odd.  For using straightforward score
  19 production, please use the latest stable version.  Development versions
  20 may not produce good or nice scores.
  21
  22 @section Requirements
  23
  24 For the compilation and running of LilyPond you need some additional
  25 packages.  Please refer to the installation instructions.
  26
  27 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
  28 you don't have to compile LilyPond.
  29
  30 @section Installation
  31
  32 For your convenience, a formatted copy of the INSTALL instructions are
  33 in the toplevel directory, as INSTALL.txt
  34
  35 @section Documentation
  36
  37 The real documentation is the directory Documentation/
  38
  39 If you want to read the documentation online, these are options:
  40 @itemize @bullet
  41 @item  use @file{.html}. Refer to INSTALL.txt for info on how to make the
  42 .html documentation.
  43 @item  use @file{.html}. Point your browser to
  44 @uref{http://www.cs.uu.nl/~hanwen/lilypond/index.html}.
  45 @item use @file{.dvi},  for the tutorial and reference manual. Do
  46
  47 @example
  48   make -C Documentation/user/ dvi
  49 @end example
  50
  51
  52 @item  use ASCII. Do
  53 using @example
  54         make -C doc
  55 @end example
  56
  57 @end itemize
  58
  59
  60 @section Comments
  61
  62 LilyPond is a long way from finished and polished.  We do appreciate
  63 criticism, comments, bugreports, patches, etc.
  64 @example
  65
  66            Please send your e-mail to one of the MAILING LISTS
  67
  68 @end example
  69
  70 and @emph{not} to us personally.  See @file{Documentation/mail.texi} for
  71 more info.
  72
  73 @section Windows 32
  74
  75 If you have received this file as part of a DOS/Window32 distribution
  76 (@file{LilyPond-*.zip}), it is advisable to also download the
  77 source package, since it might contain more documentation
  78 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}
  79
  80 If you decide to build LilyPond from source, please read the INSTALL.txt
  81 document first, especially the Windows NT/95 section.
  82
  83 @section Caveats
  84
  85 If you have installed a previous version, be sure to remove old font
  86 files, eg.,
  87 @example
  88 rm `find /var/lib/texmf/fonts -name 'feta*'`
  89 @end example
  90
  91 a script to do this for you is in @file{buildscripts/clean-fonts.sh}
  92
  93 @section Bugs
  94
  95 Send bug reports to @email{bug-gnu-music@@gnu.org}.  For help and
  96 questions use @email{help-gnu-music@@gnu.org} and
  97 @email{gnu-music-discuss@@gnu.org}.  Please consult the FAQ and
  98 installation instructions before mailing your problems.
  99
 100 @section CDROM distributions
 101
 102 If you have received LilyPond on a cdrom, chances are that development
 103 has moved some patchlevels up.  Please check the latest version of
 104 LilyPond before reporting bugs.
 105
 106
 107 @bye