General Information
===================

This is MonkeyMedia version 0.5. MonkeyMedia is a library for multimedia
playback (of which only audio is supported at this point), offering
support for seeking, managing volume, obtaining stream information like
ID3 tags and bitrate, equalizer, and GStreamer visualization plugins.

MonkeyMedia builds upon the GStreamer multimedia framework, thereby
supporting all formats for which GStreamer plugins have been written.

All data retreival is done via GnomeVFS, so it is no problem to play data
over HTTP, Samba, or whatever GnomeVFS-supported protocol you can think of.

CD metadata is retreived from Musicbrainz [http://www.musicbrainz.org],
since it's a project entirely run by volunteers we'd like to ask you to,
if you are able to, consider donating them money so that they can keep the
system running.

MonkeyMedia is free software, licensed under the GNU LGPL. This means
it can be used in commercial projects; however, you must respect the rules set
forth in the license.

The official web site is:
  http://people.nl.linux.org/~jorn/monkey-media.html

Information about mailing lists can be found at:
  http://lists.gnome.org/mailman/listinfo/rhythmbox-devel

Our IRC channel is #rhythmbox on GIMPnet (irc.gimp.org).

MonkeyMedia CVS is hosted at gnome.org, monkey-media module.

Installation
============

See the file 'INSTALL'

How to report bugs
==================

Bugs should be reported to the GNOME bug tracking system.
(http://bugzilla.gnome.org, product rhythmbox.) You will need to create an
account for yourself.

In the bug report please include:

* Information about your system. For instance:

   - GStreamer version
   - Available GStreamer plugins (run gst-inspect with no arguments)
   
  And anything else you think is relevant.

* How to reproduce the bug.

  If you can reproduce the bug with one of the programs in tests/, that
  will be most convenient.  Otherwise, please include a short test program
  that exhibits the behavior.  As a last resort, you can also provide
  a pointer to a larger piece of software that can be downloaded.

* If the bug was a crash, the exact text that was printed out when the
  crash occured, and a trace (which can be obtained by using gdb or bug-buddy).

Patches
=======

Patches should also be submitted to bugzilla.gnome.org. If the patch fixes
an existing bug, add the patch as an attachment to that bug report.

Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.

Bug reports containing patches should include the PATCH keywoard in their
keyword fields.  If the patch adds or changes the MonkeyMedia programming
interface, the API keyword should also be included.

Patches should be in unified diff form. (The -u option to GNU diff.)
