--*-text-*-
+This is the toplevel README to LilyPond -*-Text-*-
-INTRODUCTION
-This is a beta version of LilyPond (a music typesetter). Please send
-your helpful comments and patches to me,
+LilyPond is the GNU Project music typesetter. The program generates
+visual or auditive output from a music definition file: it can typeset
+formatted sheet music to a TeX file and play (mechanical) performances
+to a MIDI file. Features include multiple staffs, meters, clefs,
+keys, lyrics, versatile input-language, cadenzas, beams, slurs,
+triplets.
- hanwen@stack.urc.tue.nl
-LilyPond is updated very frequently, the latest version is always available at:
+1. VERSIONING
- ftp://pcnov095.win.tue.nl/pub/lilypond
+if you have downloaded a
-PREREQUISITES
+ *.pre*
-TeX, the MusixTeX fonts, g++ > v2.7. The "flower" library, which should be
-available from the same source you got this from.
+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.
-COMPILING
-You will need GNU C++ v2.7 or better and GNU make. If you actually
-want to use this, you'd better use the "speedy" compilation flags in
-the Makefile.
-Do:
+2. REQUIREMENTS
- tar zxf flower-1.11.9.tar.gz
- mv flower-1.11.9 flower
- cd flower; make; cd ..
- tar zxf lilypond-1.2.13.tar.gz
- cd lilypond-1.2.13
- make
+For the compilation and running of LilyPond you need some additional
+packages. Please refer to the installation instructions.
-why G++ >= 2.7? LilyPond & flower lib uses builtin bool and typeof.
-USING
+3. INSTALLATION
-No, you shouldn't. Really. If you're still not discouraged; this is
-what I type in my xterm:
+For your convenience, a formatted copy of the INSTALL instructions are
+in the toplevel directory, as INSTALL.text
- lilypond maartje.ly
- tex test
- xdvi test&
-This is what the output looks like over here.
+4. DOCUMENTATION
-hw:~/musix/spacer$ lilypond kortjakje.ly
-LilyPond version 0.0.9 compiled on Nov 7 1996 at 23:38:21
-Parsing ... [kortjakje.ly]
-Processing ... Calculating ...
-output to lelie.uit...
+The real documentation is the directory Documentation/
-hw:~/musix/spacer$ tex test
-This is TeX, Version 3.14159 (C version 6.1)
-(test.tex
-Hyphenation patterns for english, dutch, loaded.
-(lilyponddefs.tex) (lelie.uit) [1] )
-Output written on test.dvi (1 page, 3076 bytes).
-Transcript written on test.log.
+To generate the pretty-printed docs, you have to run configure first,
+and then do this:
-hw:~/musix/spacer$ xdvi test&
-[1] 1667
+ make doc
+You can also simply read the .pod sources. They are ASCII text.
+.pod is the documentation format of perl (see perlpod(1))
-PROBLEMS
-If LilyPond bombs out, then please recompile using -g, and send a gdb
-stacktrace of the crash.
+5. COMMENTS
+LilyPond is a long way from finished and polished. I do appreciate
+criticism, comments, bugreports, patches, etc. Please send e-mail to
+the mailing lists. See Documentation/links.pod for more info
-HOW DOES IT WORK
-* Use The Source, Luke. If you don't know C++, you can try editing
-.dstreamrc for copious debugging output.
+6. DOZE
-* the subdir Documentation/ contains some in depth matter on LilyPond
-algorithms
+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
-* The source is commented in the DOC++ style.
-Check out doc++ at
+ ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
+ ftp://alpha.gnu.org/gnu/lilypond/ (US)
- http://www.ZIB-Berlin.DE/VisPar/doc++/doc++.html
+The website also contains the complete documentation
+
+ http://www.stack.nl/~hanwen/lilypond/index.html
+
+If you decide to build LilyPond from source, please read the INSTALL
+document first, especially the Windows NT/95 section.
+
+
+7. CAVEATS
+
+* Please read the file BUGS for some ugly bugs. This especially applies
+Linux-Intel unix users.
+
+* 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 bin/cleanfonts.sh
projects / lilypond.git / blobdiff