release: 0.1.0

[lilypond.git] / README

diff --git a/README b/README
index 416108902bb94b8645b179d1ce660c673019fd87..39909a29c39d082eb62ea60e671435a36910acff 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,20 @@
-IMPORTANT:
+This is the toplevel README to LilyPond
+
+
+GNU LilyPond which converts music definition files into visual or
+audio output: it can typeset formatted sheet music in TeX and 
+and (mechanical) perfomances to MIDI files.
+
+0.
+
+LilyPond is known to have a minor bug if  you use glibc; we will look into it
+Please download 0.1.1 when it's available.
+
+LilyPond exhibits a g++ bug on Solaris 2.5 (The stack frame gets corrupted by
+a constructor) if you compile with -O2. We don't know workarounds 
+
+
+1. VERSIONING
 
 if you have downloaded a
 
@@ -7,7 +23,19 @@ if you have downloaded a
 version, then this is version is *not* meant for producing nice output
 (but to keep your patchsets up to date). It might not even compile.
 
-====================
+2. REQUIREMENTS
+
+For the compilation and running of LilyPond you need some additional
+packages. The most unusual one of this are the mf sources to
+MusixTeX. Please refer to the installation instructions on how to
+obtain and install them.
+
+3. INSTALLATINON
+
+For your convenience, a formatted copy of the INSTALL instructions are
+in the toplevel directory, as INSTALL.text
+
+4. DOCUMENTATION
 
 Please refer to the directory Documentation/ for the real doco.
 
@@ -16,20 +44,42 @@ and then do this:
 
        make doc
 
-You can also simply read the .pod sources. It is ASCII text. For your
-convenience, a copy of the formatted INSTALL instructions are in
-the toplevel directory, as INSTALL.text 
-
-
-======================
+You can also simply read the .pod sources. They are ASCII text. 
 
-NOTE:
+5. COMMENTS
 
 LilyPond is a long way from finished and polished. I do appreciate
 criticism, comments, bugreports, patches, etc. Please send e-mail to
-me,
+the mailing lists 
 
-       hanwen@stack.nl
+
+       info-gnu-music@vuse.vanderbilt.edu
+       help-gnu-music@vuse.vanderbilt.edu
+       bug-gnu-music@vuse.vanderbilt.edu
+       gnu-music-discuss@vuse.vanderbilt.edu,
+
+See the man page on what to use for what.  Or you can send it directly
+to us: hanwen@stack.nl, jan@digicash.com.
+
+
+       
 
 Have fun!
 
+6. DOZE
+
+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 contains the complete documentation
+
+       ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
+       ftp://alpha.gnu.ai.mit.edu/gnu/ (US)
+
+The website also contains the complete documentation
+
+       http://www.stack.nl/~hanwen/lilypond/index.html
+
+
+
+
+