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

Diff of /linuxsampler/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 5 by schoenebeck, Sat Oct 25 20:24:31 2003 UTC revision 701 by schoenebeck, Tue Jul 19 16:16:56 2005 UTC
# Line 1  Line 1 
1  LinuxSampler - modular, streaming capable sampler  LinuxSampler - modular, streaming capable sampler
2    
3  by Benno Senoner (benno@gardena.net)  Copyright (C) 2003, 2004 by Benno Senoner (benno@gardena.net)
4  and Christian Schoenebeck (cuse@users.sourceforge.net)                and Christian Schoenebeck (cuse@users.sourceforge.net)
5    Copyright (C) 2005 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), and may NOT be used in commercial applications without asking the
14    authors for permission. Also note that liblinuxsampler and its applications
15    are linking against other libraries; respect their licenses as well!
16    
17    
18    Description
19    -----------
20    
21    LinuxSampler is sampler backend, thus server-like console application. It
22    provides a TCP based network interface with a custom ASCII based protocol
23    called "LSCP" to control the sampler and manage sampler sessions. You either
24    have to send commands manually to LinuxSampler, e.g. by connecting via
25    'telnet' or by using 'netcat' or you might want to use a graphical user
26    interface (frontend) like QSampler.
27    
28    For more informations visit http://www.linuxsampler.org/documentation.html
29    
30    
31    Requirements on Linux
32    ---------------------
33    
34        o A low latency enabled kernel
35          (see http://www.linuxsampler.org/faq.html#dropouts).
36        o At least ALSA and optionally JACK and their respective development
37          (header) files as MIDI input and audio output drivers.
38        o libgig and its development (header) files for loading Gigasampler
39          format files.
40        o libtool
41        o If you are compiling from CVS you need to have the autotools installed
42          (autoconf, automake (>= 1.5)).
43        o If you want to generate the liblinuxsampler API documentation you
44          need to have Doxygen installed.
45    
46    
47    Compiling on Linux
48    ------------------
49    
50        a) Compiling and installing directly
51    
52        The general procedure by calling './configure && make' on the source's
53        toplevel directory will compile and 'make install' as root will install
54        LinuxSampler on your system.
55    
56        Note: if you are compiling from CVS you have to explicitly call
57              'make -f Makefile.cvs' before doing the above procedure. This will
58              generate all autotools managed build files.
59    
60        LinuxSampler itself is a library called liblinuxsampler. You can
61        generate the API documenation for liblinuxsampler by explicitly calling
62        'make docs'.
63    
64    
65        b) Creating Debian packages
66    
67        Simply calling 'dpkg-buildpackage -rfakeroot -b' from the source's
68        toplevel directory will compile and build the Debian binary package.
69        The Debian package will be placed one directory above the source's
70        toplevel directory (thus ../).
71    
72    
73        c) Creating Redhat packages
74    
75        You need to have the rpmbuild tool installed and properly configured to
76        create RPM packages. To create the RPM packages do the following:
77    
78        * Get .spec file generated by ./configure and edit it as appropriate.
79    
80        * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
81          where <rpmdir> is dependent to the system you are using. For SuSE
82          <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
83          Redhat / Fedora <rpmdir> always equals "redhat".
84    
85        * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
86          command line.
87    
88        On success, the resulting rpm(s) can usually be found under the proper
89        "/usr/src/<rpmdir>/RPMS/<arch>" directory.
90    
91    
92    Compilation on OSX : Stephane Letz (letz@grame.fr)
93    --------------------------------------------------
94    
95    The compilation on OSX currently uses an XCode project.
96    
97    - Download and install the JackOSX package (www.jackosx.com)
98    
99    - In the "osx" folder, possibly manually edit the version.h to change the version number
100    
101    - In the XCode project, build the "LinuxSampler" target
102    
 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.  
   
 LinuxSampler is in alpha phase and thus intended to be a DEVELOPERS VERSION  
 ONLY! A lot of functionality is not yet implemented or working correctly.  
 You may even have to adjust things to get it running on your system.  

Legend:
Removed from v.5  
changed lines
  Added in v.701

  ViewVC Help
Powered by ViewVC