+Toplevel README
+***************
+1 Toplevel README
+*****************
-This is the toplevel README to LilyPond
-***************************************
+LilyPond is a music typesetter. It produces beautiful sheet music
+using a description file as input. LilyPond is part of the GNU Project.
- LilyPond is a music typesetter. It produces beautiful sheet music
-using a high level description file as input. LilyPond is part of the
-GNU Project.
+1.1 Versioning
+==============
-Versioning
-==========
+LilyPond uses a versioning scheme that easily identifies stable and
+development releases. In a version "x.y.z", an even second number 'y'
+denotes a stable version. For development versions 'y' is odd.
- LilyPond uses a versioning scheme similar to the Linux kernel. In a
-version "x.y.z", an even second number 'y' denotes a stable version.
-For development versions 'y' is odd. So, in theory, version 1.2 is
-stable, which means that there are no glaring errors in it. In practice
-1.2.x is also unmaintained.
+1.2 Downloading
+===============
- 1.3.x is in healthy development: lots of problems turn up, but
-they're fixed quickly. Therefore we recommend you try 1.2.x, if you
-have any problem with it, upgrade to the latest 1.3.x release.
+The primary download site for sourcecode is
+`http://lilypond.org/download/'.
-Requirements
-============
+1.3 Compilation
+===============
- For the compilation and running of LilyPond you need some additional
-packages. Please refer to the installation instructions.
+For compiling and running LilyPond see the installation instructions.
+These instructions can be found when you unpack lilypond, as
+`lilypond-x.y.z/INSTALL.txt'. They are also available on the web at
+`http://lilypond.org/doc/v2.12/Documentation/topdocs/INSTALL.html'.
- NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
-don't have to compile LilyPond.
+1.4 Documentation
+=================
-Installation
-============
+The documentation is available online at `http://lilypond.org/doc/'.
- For your convenience, a formatted copy of the INSTALL instructions
-are in the toplevel directory, as INSTALL.txt
+ You can also build it locally: follow the instructions under
+`Building documentation' in the installation instructions.
-Documentation
-=============
+1.5 Comments
+============
- The real documentation is the directory Documentation/
+Send your criticism, comments, bugreports, patches, etc. to the mailing
+list, not to us personally.
- If you want to read the documentation online, these are options:
- * use HTML. Refer to INSTALL.txt for information on how to make the
- HTML documentation.
+ We have the following mailing lists:
- * use HTML. Point your browser to
- `http://www.cs.uu.nl/~hanwen/lilypond/index.html'.
+ * info-lilypond@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/info-lilypond) is a
+ low-volume list for information on LilyPond project. This
+ list is moderated; ask David R. Linn <drl@gnu.org> or
+ Han-Wen <hanwen@xs4all.nl> to send announcements for this list.
- * use `.dvi', for the tutorial and reference manual. Do
+ * lilypond-devel@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/lilypond-devel) for
+ discussions about developing LilyPond, in particular the unstable
+ series.
- make -C Documentation/user/ dvi
+ * lilypond-user@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/lilypond-user) for
+ discussions about using LilyPond, in particular the stable series.
- You need a working LilyPond binary to create the DVI and HTML
- sources.
+ * bug-lilypond@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/bug-lilypond) for sending
+ bugreports.
- * use ASCII. Do using
- make doc
+ * lilypond-cvs@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/lilypond-cvs) for log
+ files from the autobuild.
+ You can search the lists from our searching facilities
+(http://lilypond.org/search).
-Comments
+1.6 Bugs
========
- LilyPond is a long way from finished and polished. We do appreciate
-criticism, comments, bugreports, patches, etc., but please,
-
- Please send your e-mail to one of the MAILING LISTS
-
- and _not_ to us personally. We have the following mailing lists:
-
- * info-gnu-music@gnu.org
- (http://mail.gnu.org/mailman/listinfo/info-gnu-music) is a
- low-volume list for information on the GNU Music project.
- This list is moderated; ask David R. Linn <drl@gnu.org> or
- Han-Wen <hanwen@cs.uu.nl> to send announcements for this list.
-
- * help-gnu-music@gnu.org
- (http://mail.gnu.org/mailman/listinfo/help-gnu-music) For help
- with using LilyPond.
-
- * bug-gnu-music@gnu.org
- (http://mail.gnu.org/mailman/listinfo/bug-gnu-music) If you have
- bugreports, you should send them to this list.
-
-Windows 32
-==========
-
- If you have received this file as part of a DOS/Window32 distribution
-(`LilyPond-*.zip'), it is advisable to also download the source
-package, since it might contain more documentation
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/'
-
- If you decide to build LilyPond from source, please read the
-INSTALL.txt document first, especially the Windows NT/95 section.
-
-Caveats
-=======
-
- If you have installed a previous version, be sure to remove old font
-files, eg.,
- rm `find /var/lib/texmf/fonts -name 'feta*'`
-
- a script to do this for you is in `buildscripts/clean-fonts.sh'
-
-Bugs
-====
-
- Send bug reports to <bug-gnu-music@gnu.org>. For help and questions
-use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>. Please
-consult the FAQ and installation instructions before mailing your
-problems.
+Send bug reports to <bug-lilypond@gnu.org>. For help and questions use
+<lilypond-user@gnu.org>.
projects / lilypond.git / blobdiff