Documentation/topdocs/README.texi

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