(Beaming): add note about
[lilypond.git] / README.mandrake
blobe28ed007d2d8872b7d59a2c1f52e78dcab07d529
1 README.first
2 ============
4 This file created for Linux-Mandrake distribution by Michael Brown
5 <mbrown@fensystems.co.uk>
7 LilyPond is a music typesetter.  It produces beautiful sheet music using a
8 high level description file as input.
10 LilyPond is split into two packages.  The package "lilypond" provides the
11 core package, containing the utilities for converting the music source
12 (.ly) files into printable output.  The package "lilypond-documentation" 
13 provides the full documentation, example .ly files for various features and 
14 the Mutopia project files (musical equivalent of the Gutenberg project - see
15 http://www.mutopiaproject.org for details).
17 If you are new to lilypond, you will almost certainly want to install the
18 "lilypond-documentation" package in addition to the "lilypond" package.
20 You may also wish to investigate the "denemo" package, which provides a
21 graphical front end to lilypond.
25 Quick Start Guide
26 =================
28 To run lilypond:
30 Create a lilypond source (.ly) file in a directory that you can write
31 to.  (The easiest way to do this is to copy a .ly file from
32 /usr/share/doc/lilypond-1.4.2/Examples or one of the Mutopia files
33 from /usr/share/doc/lilypond-1.4.2/Mutopia - note that these folders
34 are part of the lilypond-documentation package).
36 Run "ly2dvi -P input_file.ly" (replacing input_file as appropriate).  This
37 will create a file called input_file.ps, which you can then view using
38 Ghostscript ("gv input_file.ps").
40 For an easier way to use lilypond, try the graphical front-end denemo.
44 Points to note
45 ==============
47 DO NOT use the "lilypond -f ps" option to generate a PostScript file.  It
48 is included as an experimental feature, or for platforms that do not have
49 a working TeX setup (that's not Mandrake).
50 Use "ly2dvi -P" instead.
52 [ Addendum: the "lilypond -f ps" option is now broken in this package,
53   due to the new, improved way of handling the via-LaTeX method.  It won't
54   work.  Use "ly2dvi -P" instead. ]