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

Contents of /jlscp/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1440 - (show annotations) (download)
Mon Oct 15 19:26:03 2007 UTC (12 years, 3 months ago) by iliev
File size: 2724 byte(s)
* preparations for release 0.6a

1
2 jlscp - A java LinuxSampler control protocol API
3
4 by Grigor Iliev <grigor@grigoriliev.com>
5
6
7 This library provides client API for retrieving information and
8 configuring running LinuxSampler instance according to the LinuxSampler
9 control protocol version 1.2 as specified in the LSCP specification
10 (http://www.linuxsampler.org/api/lscp-1.2.html).
11
12 For more information about LinuxSampler visit http://www.linuxsampler.org
13
14
15 The Latest Version
16 ==================
17
18 The latest version can be downloaded from
19 http://sourceforge.net/projects/jlscp/
20
21 See also: http://www.linuxsampler.org/downloads.html
22
23
24 License
25 =======
26
27 This software is licensed under the terms of
28 the GNU General Public License Version 2 (see COPYING file).
29
30
31 Requirements
32 ============
33
34 To use jlscp you need java version 1.5.0 or higher.
35
36 To build the library, the documentation or the examples you need
37 JDK version 1.5.0 or higher and the Ant tool (http://ant.apache.org/).
38
39
40 Compilation
41 ===========
42
43 Notice that the package contains both the source and the binary files.
44 So you can skip this section unless you want to rebuild the library or
45 you are using version downloaded from cvs.
46
47 To build the library, examples or documentation follow the next steps.
48
49 1. Set the JAVA_HOME environment variable to point to your JDK directory.
50 If the JDK is installed in /opt/jdk1.5.0 directory, this can be done
51 with the following command:
52
53 export JAVA_HOME=/opt/jdk1.5.0
54
55 (Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0')
56
57 2. Choose one or more of the following options.
58
59 - Building the library (jlscp.jar): `ant build-lib'
60
61 - Building the documentation: `ant build-doc'
62
63 - Building the examples: `ant build-examples'
64
65 - Building all (library, examples, documentation): `ant build-all'
66
67 Also you may specify more then one target: `ant build-lib build-examples'
68
69
70 Installation
71 ============
72
73 To install jlscp as an extension just copy jlscp.jar in the following directory:
74
75 <JDK-home>/jre/lib/ext
76
77 If you don't want to install jlscp as an extension, you may use the following
78 option when compiling or running an application that depends on it:
79
80 -cp .:/path/to/jlscp/jlscp.jar
81
82
83 Documentation
84 =============
85
86 The documentation is located in the doc directory. Also you can look at the
87 examples directory.
88
89
90 Running examples
91 ================
92
93 To run the examples `cd' to examples/build directory
94 and use one of the following commands:
95
96 java -cp /path/to/jlscp/jlscp.jar:. Poll
97 java -cp /path/to/jlscp/jlscp.jar:. Events
98 java -cp /path/to/jlscp/jlscp.jar:. CreateChannel
99
100 Notice that on Windows platforms class path entries are separated by
101 semicolons (;) instead of colons (:).
102
103 Thanks for using jlscp.
104

  ViewVC Help
Powered by ViewVC