]> git.donarmstrong.com Git - lilypond.git/blob - README
81977e36033fc59448d3583d01a31af5e0cfbfeb
[lilypond.git] / README
1 This is the toplevel README to LilyPond
2
3
4 GNU LilyPond which converts music definition files into visual or
5 audio output: it can typeset formatted sheet music in TeX and 
6 and (mechanical) perfomances to MIDI files.
7
8 1. VERSIONING
9
10 if you have downloaded a
11
12         *.pre*
13
14 version, then this is version is *not* meant for producing nice output
15 (but to keep your patchsets up to date). It might not even compile.
16
17
18 2. REQUIREMENTS
19
20 For the compilation and running of LilyPond you need some additional
21 packages. The most unusual one of this are the mf sources to
22 MusixTeX. Please refer to the installation instructions on how to
23 obtain and install them.
24
25
26 3. INSTALLATINON
27
28 For your convenience, a formatted copy of the INSTALL instructions are
29 in the toplevel directory, as INSTALL.text
30
31
32 4. DOCUMENTATION
33
34 Please refer to the directory Documentation/ for the real doco.
35
36 To generate the pretty-printed docs, you have to run configure first,
37 and then do this:
38
39         make doc
40
41 You can also simply read the .pod sources. They are ASCII text. 
42 .pod is the documentation format of perl (see perlpod(1))
43
44
45 5. COMMENTS
46
47 LilyPond is a long way from finished and polished. I do appreciate
48 criticism, comments, bugreports, patches, etc. Please send e-mail to
49 the mailing lists 
50
51
52         info-gnu-music@vuse.vanderbilt.edu
53         help-gnu-music@vuse.vanderbilt.edu
54         bug-gnu-music@vuse.vanderbilt.edu
55         gnu-music-discuss@vuse.vanderbilt.edu,
56
57 See the man page on what to use for what.  Or you can send it directly
58 to us: hanwen@stack.nl, jan@digicash.com.
59
60
61         
62
63 Have fun!
64
65 6. DOZE
66
67 If you have received this file as part of a DOS/Window32 distribution
68 (lilypond-*.zip ), then it is advisable to also download the source
69 package, since it contains the complete documentation
70
71         ftp://pcnov095.win.tue.nl/pub/lilypond/ (Europe)
72         ftp://alpha.gnu.ai.mit.edu/gnu/ (US)
73
74 The website also contains the complete documentation
75
76         http://www.stack.nl/~hanwen/lilypond/index.html
77
78
79
80
81