Documentation/topdocs/README.texi

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