]> git.donarmstrong.com Git - lilypond.git/blob - README.txt
release: 1.4.2
[lilypond.git] / README.txt
1
2
3 This is the toplevel README to LilyPond
4 ***************************************
5
6    LilyPond is a music typesetter.  It produces beautiful sheet music
7 using a high level description file as input.  LilyPond is part of the
8 GNU Project.
9
10 Versioning
11 ==========
12
13    LilyPond uses a versioning scheme similar to the Linux kernel.  In a
14 version "x.y.z", an even second number 'y' denotes a stable version.
15 For development versions 'y' is odd.
16
17    Version 1.4 is the latest stable release.
18
19 Compilation
20 ===========
21
22    For compiling and running LilyPond please refer to the installation
23 instructions.  These instructions can be found when you unpack lilypond,
24 as `lilypond-x.y.z/INSTALL.txt'.
25
26    NOTE: If you downloaded a binary (.rpm or a W95/NT .zip file), you
27 don't have to compile LilyPond.
28
29 Documentation
30 =============
31
32    The documentation is available online at `http://www.lilypond.org/'.
33 You can also build it locally. This does require a working LilyPond
34 binary.  The following formats are supported:
35    * HTML. Refer to INSTALL.txt for information on how to make the HTML
36      documentation.
37
38    * `.dvi',  for the tutorial and reference manual. Do
39
40            make -C Documentation/user/ dvi
41      The printable documentation is left in `Documentation/user/out/'.
42
43    * paper. Create the .dvi documentation, and print it with dvips.
44
45
46 Comments
47 ========
48
49    LilyPond is a long way from finished and polished, so please send
50 your criticism, comments, bugreports, patches, etc., to the mailing
51 list, _not_ to us personally.
52
53    We have the following mailing lists:
54
55    * info-gnu-music@gnu.org
56      (http://mail.gnu.org/mailman/listinfo/info-gnu-music) is a
57      low-volume list for information on the GNU Music project.
58      This list is moderated; ask     David R. Linn <drl@gnu.org> or
59      Han-Wen <hanwen@cs.uu.nl> to send announcements for this list.
60
61    * gnu-music-discuss@gnu.org
62      (http://mail.gnu.org/mailman/listinfo/gnu-music-discuss)   For
63      general discussions concerning LilyPond.
64
65    * help-gnu-music@gnu.org
66      (http://mail.gnu.org/mailman/listinfo/help-gnu-music)     For help
67      with using LilyPond.
68
69    * bug-gnu-music@gnu.org
70      (http://mail.gnu.org/mailman/listinfo/bug-gnu-music) If you have
71      bugreports, you should send them to this list.
72
73 Windows 32
74 ==========
75
76    If you have received this file as part of a DOS/Window32 distribution
77 (`LilyPond-*.zip'), it is advisable to also download the source package
78 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/), since it might contain more
79 documentation
80
81 Caveats
82 =======
83
84    If you have installed a previous version, be sure to remove old font
85 files, eg.,
86      rm `find /var/lib/texmf/fonts -name 'feta*'`
87
88    a script to do this for you is in `buildscripts/clean-fonts.sh'
89
90 Bugs
91 ====
92
93    Send bug reports to <bug-gnu-music@gnu.org>.  For help and questions
94 use <help-gnu-music@gnu.org> and <gnu-music-discuss@gnu.org>.  Please
95 consult the FAQ and installation instructions before mailing your
96 problems.
97