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.6 is the latest stable release.
  26
  27 @section Downloading
  28
  29 The primary download site for sourcecode is
  30 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
  31
  32 If you have a slow connection, then you are advised to use
  33 @uref{xdelta,ftp://ftp.xcf.berkeley.edu/pub/xdelta/} for patching
  34 source archives; Xdelta (@file{.xd}) files are supplied on the website.
  35
  36 @section Compilation
  37
  38 For compiling and running LilyPond please refer to the installation
  39 instructions.  These instructions can be found when you unpack
  40 lilypond, as @file{lilypond-x.y.z/INSTALL.txt}. They are also
  41 available on the web at
  42 @uref{http://lilypond.org/Documentation/topdocs/out-www/INSTALL.html}.
  43
  44 NOTE: If you downloaded a binary (@file{.rpm} or a W95/NT @file{.zip}
  45 file), you don't have to compile LilyPond.
  46
  47
  48 @section Documentation
  49
  50 The documentation is available online at
  51 @uref{http://www.lilypond.org/Documentation/out-www/index.html}.
  52
  53 You can also build it locally: follow the instructions under `Building
  54 website' in the installation instructions.
  55
  56
  57 @section Comments
  58
  59 LilyPond is a long way from finished so we appreciate your criticism,
  60 comments, bugreports, patches, etc. Please send them to the mailing
  61 list, @emph{not} to us personally.
  62
  63 @html
  64 <a name="mailing-lists">
  65 @end html
  66
  67 We have the following mailing lists:
  68
  69 @itemize @bullet
  70 @item @uref{http://mail.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
  71 is a low-volume list for information on the GNU Music project.
  72     This list is moderated; ask
  73     @email{drl@@gnu.org, David R. Linn} or
  74     @email{hanwen@@cs.uu.nl, Han-Wen} to send announcements for this
  75 list.
  76
  77 @item
  78 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,lilypond-devel@@gnu.org}
  79   For discussions about developing lilypond, in particular the unstable series.
  80
  81 @item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,lilypond-user@@gnu.org}
  82   For discussions about using lilypond, in particular the stable series.
  83
  84 @item @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,bug-lilypond@@gnu.org}
  85 If you have bugreports, you should send them to this list.
  86
  87 @item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-cvs,lilypond-cvs@@gnu.org}
  88   Commit messages for CVS development. This is a high-volume moderated
  89   list.
  90 @end itemize
  91
  92 You can search the lists from the following page:
  93 @uref{http://lilypond.org/search, searching facilities}.
  94
  95 @section Windows 32
  96
  97 If you have received this file as part of a DOS/Window32 distribution
  98 (@file{LilyPond-*.zip}), it is advisable to also download the
  99 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,source package}, since it
 100 might contain more documentation
 101
 102 @section Caveats
 103
 104 If you have installed a previous version, be sure to remove old font
 105 files, eg.,
 106 @example
 107 rm `find /var/lib/texmf/fonts -name 'feta*'`
 108 @end example
 109 a script to do this for you is left
 110 @file{buildscripts/out/clean-fonts}
 111
 112 @section Bugs
 113
 114 Send bug reports to @email{bug-lilypond@@gnu.org}.  For help and
 115 questions use @email{lilypond-user@@gnu.org}.  Please consult the
 116 documentation before mailing your problems.
 117
 118
 119 @bye