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{ftp://ftp.lilypond.org/pub/LilyPond/}.
  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 please refer to the installation
  33 instructions.  These instructions can be found when you unpack
  34 lilypond, as @file{lilypond-x.y.z/INSTALL.txt}. They are also
  35 available on the web at
  36 @uref{http://lilypond.org/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/Documentation/out-www/index.html}.
  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 LilyPond is a long way from finished so we appreciate your criticism,
  54 comments, bugreports, patches, etc. Please send them to the mailing
  55 list, not to us personally.
  56
  57 @html
  58 <a name="mailing-lists">
  59 @end html
  60
  61 We have the following mailing lists:
  62
  63 @itemize @bullet
  64 @item @uref{http://mail.gnu.org/mailman/listinfo/info-lilypond,info-lilypond@@gnu.org}
  65 is a low-volume list for information on the GNU Music project.
  66     This list is moderated; ask
  67     @email{drl@@gnu.org, David R. Linn} or
  68     @email{hanwen@@cs.uu.nl, Han-Wen} to send announcements for this
  69 list.
  70
  71 @item
  72 @uref{http://mail.gnu.org/mailman/listinfo/lilypond-devel,lilypond-devel@@gnu.org}
  73   for discussions about developing lilypond, in particular the unstable series.
  74
  75 @item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-user,lilypond-user@@gnu.org}
  76   for discussions about using lilypond, in particular the stable series.
  77
  78 @item @uref{http://mail.gnu.org/mailman/listinfo/bug-lilypond,bug-lilypond@@gnu.org}
  79 for bugrepots; if you have one, you should send it to this list.
  80
  81 @item @uref{http://mail.gnu.org/mailman/listinfo/lilypond-cvs,lilypond-cvs@@gnu.org}
  82   for commit messages in CVS development. This is a high-volume moderated
  83   list.
  84 @end itemize
  85
  86 You can search the lists from the following page:
  87 @uref{http://lilypond.org/search, searching facilities}.
  88
  89 @section Caveats
  90
  91 If you have installed a previous version, be sure to remove old font
  92 files, e.g.,
  93 @example
  94         rm `find /var/lib/texmf/fonts -name 'feta*'`
  95 @end example
  96 a script to do this for you is left
  97 @file{buildscripts/out/clean-fonts}.
  98
  99 @section Bugs
 100
 101 Send bug reports to @email{bug-lilypond@@gnu.org}.  For help and
 102 questions use @email{lilypond-user@@gnu.org}.  Please consult the
 103 documentation before mailing your problems.
 104
 105
 106 @bye