From 880bb9426ec1721ca485f8168dc94132edde1edf Mon Sep 17 00:00:00 2001 From: waker Date: Sun, 15 May 2011 16:17:01 +0200 Subject: updated README for 0.5 --- README | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) (limited to 'README') diff --git a/README b/README index ce85c322..f073b1b0 100644 --- a/README +++ b/README @@ -13,20 +13,18 @@ TABLE OF CONTENTS * if you want to build from git - install autotools, and run ./autogen.sh to bootstrap -* if you're compiling from tarball, or have completed previous git step.. - -* after running autogen.sh or unpacking tarball, run "./configure --help", read the output +* run "./configure --help", and read it. * now you're ready to configure the build process -- run "./configure --prefix=/usr", and wait until it finishes. you may want to change prefix to another value. consult INSTALL file for more info. -* make sure all plugins you need have "Yes" status in the list that's printed by configure. if not -- install missing dependencies. that is especially important for GTKUI, and ALSA or OSS plugins. make sure you have both. otherwise you won't get GUI and/or sound output. +* make sure all plugins which you want have "Yes" status in the list that's printed by configure. if not -- install missing dependencies, and rerun configure. that is especially important for GTKUI, and ALSA or OSS plugins. make sure you have both. otherwise you won't get GUI and/or sound output. * after satisfying all dependencies, run "make -j5" (change -j number to suit your number of CPUs/cores, e.g. 5 is quite good for single CPU dual-core machines). it is a good idea to do it as normal user (this step doesn't require root privileges). * after build finishes, run "make install" as root full list of dependencies: - libsamplerate: REQUIRED dependency, does high quality resampling + libsamplerate: for dsp_libsrc plugin (resampler) gtk+-2.0 >= 2.12 (+ gthread, + glib): GTK+ 2.0 user interface alsa-lib: ALSA support libvorbis and libogg: for ogg vorbis plugin @@ -43,7 +41,8 @@ full list of dependencies: dbus: for notification daemon support (OSD current song notifications) pulseaudio: for PulseAudio output plugin faad2: for AAC plugin - zlib: for Audio Overload plugin (psf, psf2, etc) + zlib: for Audio Overload plugin (psf, psf2, etc), GME (for vgz) + libzip: for vfs_zip plugin actual package names for your Linux distribution may vary. @@ -53,13 +52,4 @@ actual package names for your Linux distribution may vary. The Deadbeef player code is licensed under GPLv2, but this is not a requirement for plugins. Plugins don't link directly to deadbeef code, but are using special API header file which uses ZLib license. -There are several plugins included in this source distribution that have code licensed under MAME and other licenses. -Please inspect following plugins and libraries bundled with them for more info: - * plugins/dumb - uses a modified DUMB 0.9.3 library, which had issues with Debian in the past (but currently seems to be GPL-compliant) - * plugins/ao - uses Audio Overload SDK, which mixes code from many sources, under many licenses, including both GPL and MAME licenses. you might want to check legal status on distibuting linked MAME+GPL code - * plugins/shn - based on xmms-shn code, which has some code under Shorten license (see plugins/shn/LICENSE.shorten (which seems to be compatible with GPL) - -If you know other places in this project, that have licensing issues, but were not mentioned here - please let me know using this email: waker@users.sf.net -any plugins that impose licensing issues can be safely excluded from build, please see "./configure --help" output for more details -e.g. "./configure --disable-ao" will exclude AOSDK plugin from build -- cgit v1.2.3