Documentation/topdocs/README.texi

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