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.
  19
  20 Version 1.4 is the latest stable release.
  21
  22
  23 @section Compilation
  24
  25 For compiling and running LilyPond please refer to the installation
  26 instructions.  These instructions can be found when you unpack lilypond,
  27 as @file{lilypond-x.y.z/INSTALL.txt}.
  28
  29
  30 NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file),
  31 you don't have to compile LilyPond.
  32
  33
  34 @section Documentation
  35
  36 The documentation is available online at
  37 @uref{http://www.lilypond.org/}.  You can also build it locally. This
  38 does require a working LilyPond binary.  The following formats are
  39 supported:
  40 @itemize @bullet
  41
  42 @item HTML. Refer to INSTALL.txt for information
  43 on how to make the HTML documentation.
  44
  45 @item @file{.dvi},  for the tutorial and reference manual. Do
  46 @example
  47
  48  make -C Documentation/user/ dvi
  49
  50 @end example
  51 The printable documentation is left in @file{Documentation/user/out/}.
  52
  53 @item paper. Create the .dvi documentation, and print it with dvips.
  54
  55 @end itemize
  56
  57
  58 @section Comments
  59
  60 LilyPond is a long way from finished and polished, so please send your
  61 criticism, comments, bugreports, patches, etc., to the mailing list,
  62 @emph{not} to us personally.
  63
  64 We have the following mailing lists:
  65
  66 @itemize @bullet
  67 @item @uref{http://mail.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
  68 is a low-volume list for information on the GNU Music project.
  69     This list is moderated; ask
  70     @email{drl@@gnu.org, David R. Linn} or
  71     @email{hanwen@@cs.uu.nl, Han-Wen} to send announcements for this
  72 list.
  73 @item
  74 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,lilypond-devel@@gnu.org}
  75   For discussions about developing lilypond, in particular the unstable series.
  76
  77 @item @uref{http://mail.gnu.org/mailman/listinfo/help-lilypond,help-lilypond@@gnu.org}
  78   For discussions about using lilypond, in particular the stable series.
  79
  80 @item @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,bug-lilypond@@gnu.org}
  81 If you have bugreports, you should send them to this list.
  82 @end itemize
  83
  84
  85 @section Windows 32
  86
  87 If you have received this file as part of a DOS/Window32 distribution
  88 (@file{LilyPond-*.zip}), it is advisable to also download the
  89 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,source package}, since it
  90 might contain more documentation
  91
  92 @section Caveats
  93
  94 If you have installed a previous version, be sure to remove old font
  95 files, eg.,
  96 @example
  97 rm `find /var/lib/texmf/fonts -name 'feta*'`
  98 @end example
  99
 100 a script to do this for you is in @file{buildscripts/clean-fonts.sh}
 101
 102 @section Bugs
 103
 104 Send bug reports to @email{bug-lilypond@@gnu.org}.  For help and
 105 questions use @email{help-lilypond@@gnu.org} and
 106 @email{lilypond-discuss@@gnu.org}.  Please consult the FAQ and
 107 installation instructions before mailing your problems.
 108
 109
 110
 111 @bye