
Rosegarden-4 v1.0
=================

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

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 check whether your bug has
already been reported on the bug tracker:

  http://sourceforge.net/tracker/?group_id=4932&atid=104932

and if it hasn't, please report it there!


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

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

Our code compiles with gcc-3.x.

For MIDI support on Linux, you need ALSA 0.9.x or 1.0; for audio you
also need JACK 0.77 or newer.


Compiling from source
---------------------

If you obtained the source code from a distribution tarball: 

  Just run 

    ./configure

  plus appropriate "--with-qt-dir=..." and "--prefix=..." options.
  Then proceed with "make" and "make install".


NOTE: The installation prefix should be the same as the one of your
KDE installation. However you can install to another directory, but
then you'll have to append it to your KDEDIRS variable. For instance :

KDEDIRS=/usr:/home/glaurent/rosegarden


If you obtained the source code from the SourceForge CVS repository:

  grab one of the developers' configure scripts such as
  "gl_configure", edit it to your needs (you will most likely first
  need to change the Qt and KDE install paths in the script according
  to your setup), and run it. It will setup your source tree so you'll
  just have to run "make" afterwards.

  For more info, you can refer to the "COMPILING" file found in the
  KDE source code for a description of how to compile code from CVS,
  but the xx_configure scripts should perform the actions described in
  that file for you (make -f Makefile.cvs ; ./configure...).

  After configuring, run "make" and, if the compile succeeds, "make
  install".  (The pixmaps need to be installed to the global KDE
  directories before the application will run correctly.)


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

Just run the "rosegarden" application (found in the KDE bin directory
after installation, and also in the gui/ directory of the source
tree).  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, consult the FAQ:

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

or if that doesn't answer your question then use the rosegarden-user
mailing list on Sourceforge.

You can also "make uninstall" if you decide it's a waste of your time.


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 files in docs/task_lists/ for some idea of the things
we're already thinking about doing for the next developer release.
Good ideas are also welcome.

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


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

There is a semi-reference Help (Help menu -> Rosegarden Handbook),
which is not yet complete but is slated to be completed by 1.0.  There
is also a tutorial (Help menu -> Rosegarden Online Tutorial), which
again is scheduled for completion for the 1.0 release.


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

All the documentation we have is in the docs/ subdirectory.  Good
starting-points include:

  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!)

  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/task_lists/tasks_available.txt and
  docs/task_lists/1.0_release.txt -- ideas for what to do next (see also
  the SourceForge tracker page for feature requests and bug reports)


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

* Rosegarden-4 is Copyright 2000-2005 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-4 are derived from Rosegarden 2.1, which is
  Copyright 1994 - 2001 Chris Cannam, Andrew Green, Richard Bown and
  Guillaume Laurent.

* For musical notation display Rosegarden-4 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, and Michael McIntyre.  See AUTHORS for more details, and
  the individual source files for copyright attributions.

* The Rosegarden splash-screen image is from a 1900 postcard of Thornden
  Park at Syracuse University, Syracuse, NY.  It is probably out of
  copyright, but is nonetheless used with permission from and thanks to
  the staff of Syracuse University.

Rosegarden-4 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.

