--- linuxsampler/trunk/README 2005/05/24 19:20:20 579 +++ linuxsampler/trunk/README 2006/11/24 17:43:09 937 @@ -1,18 +1,32 @@ LinuxSampler - modular, streaming capable sampler -by Benno Senoner (benno@gardena.net) -and Christian Schoenebeck (cuse@users.sourceforge.net) +Copyright (C) 2003, 2004 by Benno Senoner (benno@gardena.net) + and Christian Schoenebeck (cuse@users.sourceforge.net) +Copyright (C) 2005, 2006 Christian Schoenebeck -This software is distributed under the GNU General Public License (see -COPYING file), and may not be used in commercial applications without asking -the authors for permission. + +License +------- + +The LinuxSampler library (liblinuxsampler) and its applications are +distributed under the terms of the GNU General Public License (see COPYING +file), but with the EXCEPTION that they may NOT be used in COMMERCIAL +software or hardware products without prior written authorization by the +authors. + +Also note that liblinuxsampler and its applications are linking against +other libraries; respect their licenses as well! + + +Description +----------- LinuxSampler is sampler backend, thus server-like console application. It provides a TCP based network interface with a custom ASCII based protocol called "LSCP" to control the sampler and manage sampler sessions. You either have to send commands manually to LinuxSampler, e.g. by connecting via 'telnet' or by using 'netcat' or you might want to use a graphical user -interface (frontend) like QSampler. +interface (frontend) like QSampler (C++/Qt based) or JSampler (Java based). For more informations visit http://www.linuxsampler.org/documentation.html @@ -22,28 +36,37 @@ o A low latency enabled kernel (see http://www.linuxsampler.org/faq.html#dropouts). - o At least ALSA and optionally JACK and their respective development - (header) files as MIDI input and audio output drivers. + o At least one supported MIDI input system (i.e. ALSA, CoreMIDI or + MidiShare) and at least one support audio output system (i.e. ALSA, + JACK or ARTS) have to be installed, along with their respective + development (header) files. o libgig and its development (header) files for loading Gigasampler format files. + o libtool o If you are compiling from CVS you need to have the autotools installed - (autoconf, automake and libtool). + (autoconf, automake (>= 1.5)). + o If you want to generate the liblinuxsampler API documentation you + need to have Doxygen installed. Compiling on Linux ------------------ a) Compiling and installing directly - + The general procedure by calling './configure && make' on the source's toplevel directory will compile and 'make install' as root will install LinuxSampler on your system. - + Note: if you are compiling from CVS you have to explicitly call 'make -f Makefile.cvs' before doing the above procedure. This will generate all autotools managed build files. - + LinuxSampler itself is a library called liblinuxsampler. You can + generate the API documenation for liblinuxsampler by explicitly calling + 'make docs'. + + b) Creating Debian packages Simply calling 'dpkg-buildpackage -rfakeroot -b' from the source's @@ -51,7 +74,7 @@ The Debian package will be placed one directory above the source's toplevel directory (thus ../). - + c) Creating Redhat packages You need to have the rpmbuild tool installed and properly configured to @@ -74,7 +97,7 @@ Compilation on OSX : Stephane Letz (letz@grame.fr) -------------------------------------------------- -The compilation on OSX currently uses an XCode project. +The compilation on OSX currently uses an XCode project. - Download and install the JackOSX package (www.jackosx.com)