
Rosegarden v1.5.1
=================

Rosegarden is a MIDI and audio sequencer and musical notation editor.

  http://www.rosegardenmusic.com/

Please keep an eye on the FAQ for known problems and workarounds:

  http://www.rosegardenmusic.com/resources/faq/

When you find bugs, first check whether a newer version of Rosegarden
has been released yet; if not, please continue on to:

  http://rosegarden.sourceforge.net/tutorial/bug-guidelines.html


Build requirements
------------------

The big requirement is KDE 3.3, or later, or more specifically the KDE
3.3+ development libraries (you don't need the whole KDE environment).

Our code compiles with gcc-3.x and gcc-4.x.

For MIDI support on Linux, you need ALSA 0.9.x or 1.0; for audio you
need JACK 0.77 or newer; for synth plugins you need DSSI 0.9.x or
newer; for synth plugin GUI support you need liblo 0.7 or newer.

We have recently switched to CMake for building (having previously
started out with autotools and then switched to scons -- sorry!).
Please read the INSTALL file for details of how to build and install
Rosegarden using CMake.


Running Rosegarden
------------------

Just run the "rosegarden" application (found in the KDE bin directory
after installation).  The sequencer process is started automatically
when the gui is started, provided it has been correctly installed (by
"make install") in the global KDE directories.

If you have any problems running the application, review the
instructions in the INSTALL file and consult the FAQ:

  http://www.rosegardenmusic.com/resources/faq/

If that doesn't answer your question, use the rosegarden-user mailing
list on SourceForge.


User documentation
------------------

There is a lot of documentation for Rosegarden available through the
Help menu.  Go to Help -> Rosegarden Handbook for the reference
manual, and Help -> Online Tutorial for a tutorial.


SPECIAL NOTES FOR PACKAGE MAINTAINERS
-------------------------------------

DSSI

Many distros released their packages of Rosegarden v1.0 compiled
without the optional DSSI/synth plugin support.  We received a lot of
complaints on our lists from your users and ours about your packages
being built without this feature.

We would like to request that you please take whatever steps are
necessary within the framework of your particular distro to ensure
that Rosegarden is built with DSSI support, and ideally that some of
the currently available DSSI plugins are also packaged for your
distro.  Thank you.  For details on DSSI, see:

  http://dssi.sourceforge.net/


Notes for developers
--------------------

We are actively seeking developers who are interested in coding new
parts of the application, adding features, and fixing bugs.  See the
bug and feature request trackers at SourceForge for inspiration.  If
you intend to do anything, please discuss it on the rosegarden-devel
mailing list (of course, providing working code will make your
argument extra persuasive).

Be warned that we tend to be fairly strict about code quality... as
far as that's possible, given the not always superb standards of our
own code.


Developer documentation
-----------------------

All the documentation we have (not enough) is in the docs/
subdirectory, including:

  docs/code/global_design.txt -- which classes do what, more or less
  docs/data_struct/units.txt -- how we store pitch and time
  docs/data_struct/sets.txt -- some terminology explained

  docs/howtos/alsa-notes -- brief notes about getting and installing the
	ALSA sound drivers (we recommend ALSA for use with Rosegarden)
  docs/howtos/artsd-mcop-notes.txt -- notes on how to get sound with aRts
	(not recommended!)


Authors and copyright
---------------------

* Rosegarden is Copyright 2000-2007 Guillaume Laurent, Chris Cannam
  and Richard Bown.

* The moral right of Guillaume Laurent, Chris Cannam and Richard Bown
  to be identified as the authors of this work has been asserted.

* Parts of Rosegarden are derived from X11 Rosegarden 2.1, which is
  Copyright 1994 - 2001 Chris Cannam, Andrew Green, Richard Bown and
  Guillaume Laurent.

* For musical notation display Rosegarden uses pixmaps derived from
  the Feta font, part of the Lilypond software (http://lilypond.org/)
  which is Copyright 1997 - 2004 Jan Nieuwenhuizen and Han-Wen Nienhuys.

* Other major contributors include Randall Farmer, Ron Kuris, Hans
  Kieserman, Michael McIntyre, Pedro Lopez-Cabanillas, Heikki Junes,
  Stephen Torri, Magnus Johansson, Vince Negri and Martin Shepherd.
  See AUTHORS for more details, and the individual source files for
  copyright attributions.

* The Rosegarden splash-screen image is Copyright 2006 D Michael McIntyre.

Rosegarden is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at
your option) any later version.  See the file COPYING included with
this distribution for more information.

