lilypond-0.1.57
[lilypond.git] / README
blob82740ef2da72d4c22de8a3d97eae594bf2b77a61
1 This is the toplevel README to LilyPond         -*-Text-*-
4 LilyPond is the GNU Project music typesetter.  The program generates
5 visual or auditive output from a music definition file: it can typeset
6 formatted sheet music to a TeX file and play (mechanical) performances
7 to a MIDI file.  Features include multiple staffs, meters, clefs,
8 keys, lyrics, versatile input-language, cadenzas, beams, slurs,
9 triplets.
12 1. VERSIONING
14 if you have downloaded a
16         *.pre*
18 version, then this is version is *not* meant for producing nice output
19 (but to keep your patchsets up to date). It might not even compile.
22 2. REQUIREMENTS
24 For the compilation and running of LilyPond you need some additional
25 packages. The most unusual one of this are the metafont sources to
26 MusixTeX-fonts. Please refer to the installation instructions on how
27 to obtain and install them.
30 3. INSTALLATION
32 For your convenience, a formatted copy of the INSTALL instructions are
33 in the toplevel directory, as INSTALL.text
36 4. DOCUMENTATION
38 The real documentation is the directory Documentation/
40 To generate the pretty-printed docs, you have to run configure first,
41 and then do this:
43         make doc
45 You can also simply read the .pod sources. They are ASCII text. 
46 .pod is the documentation format of perl (see perlpod(1))
49 5. COMMENTS
51 LilyPond is a long way from finished and polished.  I do appreciate
52 criticism, comments, bugreports, patches, etc.  Please send e-mail to
53 the mailing lists.  See Documentation/links.pod for more info
56 6. DOZE
58 If you have received this file as part of a DOS/Window32 distribution
59 (lilypond-*.zip), then it is advisable to also download the source
60 package, since it might contain more documentation
62         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
63         ftp://alpha.gnu.org/gnu/lilypond/ (US)
65 The website also contains the complete documentation
67         http://www.stack.nl/~hanwen/lilypond/index.html
69 If you decide to build LilyPond from source, please read the INSTALL
70 document first, especially the Windows NT/95 section.
72 7. CAVEATS
74 * Please read the file BUGS for some ugly bugs.  This especially applies
75 Linux-Intel unix users.
77 * If you have installed a previous version, be sure to remove old font
78 files, eg
80         rm `find /var/lib/texmf/fonts -name 'feta*'`
82 a script to do this for you is in bin/cleanfonts.sh