+Toplevel README
+***************
- This is the toplevel README to LilyPond
+1 Toplevel README
+*****************
-LilyPond is a music typesetter. It produces beautiful sheet
-music using a high level description file as input. Lily-
-Pond is part of the GNU Project.
+LilyPond is a music typesetter. It produces beautiful sheet music
+using a description file as input. LilyPond is part of the GNU Project.
-1: VERSIONING
+1.1 Versioning
+==============
-LilyPond uses a versioning scheme similar to the Linux ker-
-nel. In a version "x.y.z", an even second number 'y'
-denotes a stable version. For development versions 'y' is
-odd. For using straightforward score production, please use
-the latest stable version. Development versions may not
-produce good or nice scores.
+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.
-2: REQUIREMENTS
+1.2 Downloading
+===============
-For the compilation and running of LilyPond you need some
-additional packages. Please refer to the installation
-instructions.
+The primary download site for sourcecode is
+`http://lilypond.org/download/'.
-NOTE: If you downloaded a binary (.rpm or a W95/NT .zip
-file), then you don't have to compile LilyPond.
+1.3 Compilation
+===============
-3: INSTALLATION
+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'.
-For your convenience, a formatted copy of the INSTALL
-instructions are in the toplevel directory, as INSTALL.txt
+1.4 Documentation
+=================
-The process is fairly straightforward, but chances are that
-you have to specify directories for to configure: this is
-done with the options --enable-tex-dir and --enable-mf-dir
+The documentation is available online at `http://lilypond.org/doc/'.
-4: DOCUMENTATION
+ You can also build it locally: follow the instructions under
+`Building documentation' in the installation instructions.
-The real documentation is the directory Documentation/
+1.5 Comments
+============
-If you want to read the documentation online, these are
-options:
+Send your criticism, comments, bugreports, patches, etc. to the mailing
+list, not to us personally.
-o use .html. Refer to INSTALL.txt for info on how to make
- the .html documentation.
+ We have the following mailing lists:
-o 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.
-o 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/tex/ dvi
+ * lilypond-user@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/lilypond-user) for
+ discussions about using LilyPond, in particular the stable series.
-o use ASCII. Do using
+ * bug-lilypond@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/bug-lilypond) for sending
+ bugreports.
- make -C Documentation/
+ * lilypond-cvs@gnu.org
+ (http://lists.gnu.org/mailman/listinfo/lilypond-cvs) for log
+ files from the autobuild.
- The tutorial and the reference manual can not be made
- in ASCII, as they contain graphics.
+ You can search the lists from our searching facilities
+(http://lilypond.org/search).
-5: COMMENTS
+1.6 Bugs
+========
-LilyPond is a long way from finished and polished. We do
-appreciate criticism, comments, bugreports, patches, etc.
+Send bug reports to <bug-lilypond@gnu.org>. For help and questions use
+<lilypond-user@gnu.org>.
- Please send your e-mail to one of the MAILING LISTS
-
-and not to us personally. See Documentation/links.yo for
-more info.
-
-6: WINDOWS 32
-
-If you have received this file as part of a DOS/Window32
-distribution (LilyPond-*.zip), then 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.
-
-7: CAVEATS
-
-* Please read the file BUGS for some ugly bugs.
-
-* 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
-
-8: BUGS
-
-Send bug reports to bug-gnu-music@gnu.org. For help and
-questions use help-gnu-music@gnu.org and gnu-music-dis-
-cuss@gnu.org. Please consult the faq before mailing your
-problems.
-
-9: CDROM DISTRIBUTIONS
-
-If you have received LilyPond on a cdrom, chances are that
-development has moved a some patchlevels up. Please check
-the latest version of LilyPond before reporting bugs.
projects / lilypond.git / blobdiff