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

Annotation of /jlscp/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 784 - (hide annotations) (download)
Mon Oct 10 14:55:44 2005 UTC (18 years, 5 months ago) by iliev
File size: 2753 byte(s)
* Updating to version 0.3a (see ChangeLog)

1 iliev 596
2     jlscp - A java LinuxSampler control protocol API
3    
4     by Grigor Iliev <gr.iliev@gmail.com>
5    
6    
7     This library provides client API for retrieving information and
8     configuring running LinuxSampler instance according to the LinuxSampler
9 iliev 671 control protocol version 1.0 as specified in the LSCP specification written
10     by Christian Schoenebeck (http://www.linuxsampler.org/api/lscp-1.0.html).
11 iliev 596
12     For more information about LinuxSampler visit http://www.linuxsampler.org
13    
14    
15 iliev 784 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 iliev 596 Requirements
32 iliev 671 ============
33 iliev 596
34     To use jlscp you need java version 1.5.0 or higher.
35    
36 iliev 671 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 iliev 596
39 iliev 671
40 iliev 596 Compilation
41 iliev 671 ===========
42 iliev 596
43 iliev 671 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 iliev 596
49 iliev 671 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 iliev 596
53 iliev 671 export JAVA_HOME=/opt/jdk1.5.0
54 iliev 596
55 iliev 671 (Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0')
56 iliev 596
57 iliev 671 2. Choose one or more of the following options.
58 iliev 596
59 iliev 671 - 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 iliev 596 Installation
71 iliev 671 ============
72 iliev 596
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 iliev 671 =============
85 iliev 596
86     The documentation is located in the doc directory. Also you can look at the
87     examples directory.
88    
89    
90     Running examples
91 iliev 671 ================
92 iliev 596
93 iliev 671 To run the examples `cd' to examples/build directory
94 iliev 596 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 iliev 784 Thanks for using jlscp.
104    

  ViewVC Help
Powered by ViewVC