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
  42 @item  use HTML. Refer to INSTALL.txt for information
  43 on how to make the HTML documentation.
  44
  45 @item  use HTML. Point your browser to
  46 @uref{http://www.cs.uu.nl/~hanwen/lilypond/index.html}.
  47 @item use @file{.dvi},  for the tutorial and reference manual. Do
  48
  49 @example
  50   make -C Documentation/user/ dvi
  51 @end example
  52
  53 You need a working LilyPond binary to create the DVI sources  .
  54
  55
  56 @item  use ASCII. Do
  57 using @example
  58         make doc
  59 @end example
  60
  61 @end itemize
  62
  63
  64 @section Comments
  65
  66 LilyPond is a long way from finished and polished.  We do appreciate
  67 criticism, comments, bugreports, patches, etc., but please,
  68 @example
  69
  70            Please send your e-mail to one of the MAILING LISTS
  71
  72 @end example
  73
  74 and @emph{not} to us personally.  See @file{Documentation/mail.texi} for
  75 more info.
  76
  77 @section Windows 32
  78
  79 If you have received this file as part of a DOS/Window32 distribution
  80 (@file{LilyPond-*.zip}), it is advisable to also download the
  81 source package, since it might contain more documentation
  82 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}
  83
  84 If you decide to build LilyPond from source, please read the INSTALL.txt
  85 document first, especially the Windows NT/95 section.
  86
  87 @section Caveats
  88
  89 If you have installed a previous version, be sure to remove old font
  90 files, eg.,
  91 @example
  92 rm `find /var/lib/texmf/fonts -name 'feta*'`
  93 @end example
  94
  95 a script to do this for you is in @file{buildscripts/clean-fonts.sh}
  96
  97 @section Bugs
  98
  99 Send bug reports to @email{bug-gnu-music@@gnu.org}.  For help and
 100 questions use @email{help-gnu-music@@gnu.org} and
 101 @email{gnu-music-discuss@@gnu.org}.  Please consult the FAQ and
 102 installation instructions before mailing your problems.
 103
 104 @section CDROM distributions
 105
 106 If you have received LilyPond on a cdrom, chances are that development
 107 has moved some patchlevels up.  Please check the latest version of
 108 LilyPond before reporting bugs.
 109
 110
 111 @bye