-------------------------------------------------------------------------------
 streamtuner-local overview
-------------------------------------------------------------------------------

Index

	0. About this document
	1. About streamtuner-local
	2. Usage
	3. Release notes
	4. Documentation map

0. About this document

	$Id: README,v 1.6 2004/03/29 11:53:48 jylefort Exp $

	Copyright (c) 2003, 2004 Jean-Yves Lefort.

	This document is part of streamtuner-local.
	It may be distributed under the same terms as streamtuner-local.

1. About streamtuner-local

	streamtuner-local is a streamtuner plugin providing access to
	your local music collection. It can read and modify ID3 and
	Vorbis metadata.

	streamtuner is a stream directory browser, available at
	http://www.nongnu.org/streamtuner/

2. Usage

	Before using the plugin, you should point the
	STREAMTUNER_LOCAL_ROOT environment variable to the full path
	of your music collection.

	For instance:

		STREAMTUNER_LOCAL_ROOT=~/music/mp3 streamtuner

	GLib considers that filenames not encoded in plain ASCII or
	UTF-8 are "broken": you might have to define the
	G_BROKEN_FILENAMES environment variable (see
	http://www.gtk.org/gtk-2.0.0-notes.html for further details).

3. Release notes

	The STREAMTUNER_LOCAL_EXTENSIONS environment variable is now
	obsolete. Handled extensions are now hard-coded (.mp3, .ogg,
	.m3u and .pls).

	The cache format has changed: data loaded from older versions
	of the plugin will be meaningless. Click the Refresh toolbar
	button if you have such data.

	Because of the inclusion of Michael Smith's vcedit code, we
	now use the GNU General Public License.

4. Documentation map

	The following documents are included in the distribution:

		COPYING		licensing information

		README		this document

		INSTALL		installation instructions

		NEWS		reverse chronology of changes,
				manually edited

		ChangeLog	reverse chronology of changes,
				automatically generated from CVS
				commit messages
