/[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 863 by schoenebeck, Sun May 7 18:47:16 2006 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, 2006 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.
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 ALSA and optionally JACK and their respective development
40          (header) files as MIDI input and audio output drivers.
41        o libgig and its development (header) files for loading Gigasampler
42          format files.
43        o libtool
44        o If you are compiling from CVS you need to have the autotools installed
45          (autoconf, automake (>= 1.5)).
46        o If you want to generate the liblinuxsampler API documentation you
47          need to have Doxygen installed.
48    
49    
50    Compiling on Linux
51    ------------------
52    
53        a) Compiling and installing directly
54    
55        The general procedure by calling './configure && make' on the source's
56        toplevel directory will compile and 'make install' as root will install
57        LinuxSampler on your system.
58    
59        Note: if you are compiling from CVS you have to explicitly call
60              'make -f Makefile.cvs' before doing the above procedure. This will
61              generate all autotools managed build files.
62    
63        LinuxSampler itself is a library called liblinuxsampler. You can
64        generate the API documenation for liblinuxsampler by explicitly calling
65        'make docs'.
66    
67    
68        b) Creating Debian packages
69    
70        Simply calling 'dpkg-buildpackage -rfakeroot -b' from the source's
71        toplevel directory will compile and build the Debian binary package.
72        The Debian package will be placed one directory above the source's
73        toplevel directory (thus ../).
74    
75    
76        c) Creating Redhat packages
77    
78        You need to have the rpmbuild tool installed and properly configured to
79        create RPM packages. To create the RPM packages do the following:
80    
81        * Get .spec file generated by ./configure and edit it as appropriate.
82    
83        * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
84          where <rpmdir> is dependent to the system you are using. For SuSE
85          <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
86          Redhat / Fedora <rpmdir> always equals "redhat".
87    
88        * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
89          command line.
90    
91        On success, the resulting rpm(s) can usually be found under the proper
92        "/usr/src/<rpmdir>/RPMS/<arch>" directory.
93    
94    
95    Compilation on OSX : Stephane Letz (letz@grame.fr)
96    --------------------------------------------------
97    
98    The compilation on OSX currently uses an XCode project.
99    
100    - Download and install the JackOSX package (www.jackosx.com)
101    
102    - In the "osx" folder, possibly manually edit the version.h to change the version number
103    
104    - In the XCode project, build the "LinuxSampler" target
105    
 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.863

  ViewVC Help
Powered by ViewVC