/[svn]/linuxsampler/trunk/README
ViewVC logotype

Contents of /linuxsampler/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1956 - (show annotations) (download)
Fri Jul 31 07:45:47 2009 UTC (8 years, 9 months ago) by schoenebeck
File size: 3746 byte(s)
* preparations for release 1.0.0

1 LinuxSampler - modular, streaming capable sampler
2
3 Copyright (C) 2003, 2004 by Benno Senoner (benno@gardena.net)
4 and Christian Schoenebeck (cuse@users.sourceforge.net)
5 Copyright (C) 2005 - 2009 Christian Schoenebeck
6
7
8 License
9 -------
10
11 The LinuxSampler library (liblinuxsampler) and its applications are
12 distributed under the terms of the GNU General Public License (see COPYING
13 file), but with the EXCEPTION that they may NOT be used in COMMERCIAL
14 software or hardware products without prior written authorization by the
15 authors.
16
17 Also note that liblinuxsampler and its applications are linking against
18 other libraries; respect their licenses as well!
19
20
21 Description
22 -----------
23
24 LinuxSampler is sampler backend, thus server-like console application. It
25 provides a TCP based network interface with a custom ASCII based protocol
26 called "LSCP" to control the sampler and manage sampler sessions. You either
27 have to send commands manually to LinuxSampler, e.g. by connecting via
28 'telnet' or by using 'netcat' or you might want to use a graphical user
29 interface (frontend) like QSampler (C++/Qt based) or JSampler (Java based).
30
31 For more informations visit http://www.linuxsampler.org/documentation.html
32
33
34 Requirements on Linux
35 ---------------------
36
37 o A low latency enabled kernel
38 (see http://www.linuxsampler.org/faq.html#dropouts).
39 o At least one supported MIDI input system (i.e. ALSA, JACK, CoreMIDI or
40 MidiShare) and at least one support audio output system (i.e. ALSA,
41 JACK or ARTS) have to be installed, along with their respective
42 development (header) files.
43 o libgig and its development (header) files for loading Gigasampler
44 format files.
45 o libtool
46 o If you are compiling from CVS you need to have the autotools installed
47 (autoconf, automake (>= 1.5)).
48 o If you want to generate the liblinuxsampler API documentation you
49 need to have Doxygen installed.
50
51
52 Compiling on Linux
53 ------------------
54
55 a) Compiling and installing directly
56
57 The general procedure by calling './configure && make' on the source's
58 toplevel directory will compile and 'make install' as root will install
59 LinuxSampler on your system.
60
61 Note: if you are compiling from CVS you have to explicitly call
62 'make -f Makefile.cvs' before doing the above procedure. This will
63 generate all autotools managed build files.
64
65 LinuxSampler itself is a library called liblinuxsampler. You can
66 generate the API documenation for liblinuxsampler by explicitly calling
67 'make docs'.
68
69
70 b) Creating Debian packages
71
72 Simply calling 'dpkg-buildpackage -rfakeroot -b' from the source's
73 toplevel directory will compile and build the Debian binary package.
74 The Debian package will be placed one directory above the source's
75 toplevel directory (thus ../).
76
77
78 c) Creating Redhat packages
79
80 You need to have the rpmbuild tool installed and properly configured to
81 create RPM packages. To create the RPM packages do the following:
82
83 * Get .spec file generated by ./configure and edit it as appropriate.
84
85 * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
86 where <rpmdir> is dependent to the system you are using. For SuSE
87 <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
88 Redhat / Fedora <rpmdir> always equals "redhat".
89
90 * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
91 command line.
92
93 On success, the resulting rpm(s) can usually be found under the proper
94 "/usr/src/<rpmdir>/RPMS/<arch>" directory.
95
96
97 Compilation on OSX
98 ------------------
99
100 Please read osx/README.osx for detailed instructions about how to
101 compile the sampler for Mac OSX.

  ViewVC Help
Powered by ViewVC