Documentation/topdocs/README.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename README.info
   3 @settitle Toplevel README
   4
   5 @documentencoding utf-8
   6 @documentlanguage en
   7
   8 @node Top
   9 @top
  10
  11 @chapter Toplevel README
  12
  13
  14 LilyPond is a music typesetter.  It produces beautiful sheet music
  15 using a description file as input.  LilyPond is part of the GNU
  16 Project.
  17
  18 @section Versioning
  19
  20 LilyPond uses a versioning scheme similar to the Linux kernel.  In a
  21 version "x.y.z", an even second number 'y' denotes a stable version.
  22 For development versions 'y' is odd.
  23
  24 @section Downloading
  25
  26 The primary download site for sourcecode is
  27 @uref{http://lilypond.org/download/}.
  28
  29 If you have a slow connection, then you are advised to use
  30 @uref{http://sourceforge.net/projects/xdelta/,xdelta} for patching
  31 source archives; Xdelta (@file{.xd}) files are supplied on the FTP site.
  32
  33 @section Compilation
  34
  35 For compiling and running LilyPond see the installation instructions.
  36 These instructions can be found when you unpack lilypond, as
  37 @file{lilypond-x.y.z/INSTALL.txt}. They are also available on the web
  38 at
  39 @uref{http://lilypond.org/doc/v2.1/Documentation/topdocs/out-www/INSTALL.html}.
  40
  41 NOTE: If you downloaded a binary (@file{.rpm}) or use the Cygwin
  42 @file{setup.exe} program, then you don't have to compile LilyPond.
  43
  44
  45 @section Documentation
  46
  47 The documentation is available online at
  48 @uref{http://www.lilypond.org/doc/}.
  49
  50 You can also build it locally: follow the instructions under `Building
  51 documentation' in the installation instructions.
  52
  53
  54 @section Comments
  55
  56 Send your criticism, comments, bugreports, patches, etc. to the mailing
  57 list, not to us personally.
  58
  59 @html
  60 <a name="mailing-lists">
  61 @end html
  62
  63 We have the following mailing lists:
  64
  65 @itemize @bullet
  66 @item @uref{http://mail.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
  67 is a low-volume list for information on LilyPond project.
  68     This list is moderated; ask
  69     @email{drl@@gnu.org, David R. Linn} or
  70     @email{hanwen@@cs.uu.nl, Han-Wen} to send announcements for this
  71 list.
  72
  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/lilypond-user,lilypond-user@@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 for sending bugreports.
  82
  83 @item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-cvs,lilypond-cvs@@gnu.org}
  84   for commit messages in CVS development. This is a high-volume moderated
  85   list.
  86 @end itemize
  87
  88 You can search the lists from the following page:
  89 @uref{http://lilypond.org/search, searching facilities}.
  90
  91 @section Bugs
  92
  93 Send bug reports to @email{bug-lilypond@@gnu.org}.  For help and
  94 questions use @email{lilypond-user@@gnu.org}.
  95
  96
  97 @bye