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

Diff of /jlscp/trunk/README

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

revision 670 by iliev, Wed Jun 1 07:11:31 2005 UTC revision 671 by iliev, Wed Jun 22 06:18:33 2005 UTC
# Line 6  by Grigor Iliev <gr.iliev@gmail.com> Line 6  by Grigor Iliev <gr.iliev@gmail.com>
6    
7  This library provides client API for retrieving information and  This library provides client API for retrieving information and
8  configuring running LinuxSampler instance according to the LinuxSampler  configuring running LinuxSampler instance according to the LinuxSampler
9  control protocol as specified in the LSCP protocol specification  control protocol version 1.0 as specified in the LSCP specification written
10  (http://www.linuxsampler.org/api/draft-linuxsampler-protocol.html)  by Christian Schoenebeck (http://www.linuxsampler.org/api/lscp-1.0.html).
 written by Christian Schoenebeck.  
11    
12  For more information about LinuxSampler visit http://www.linuxsampler.org  For more information about LinuxSampler visit http://www.linuxsampler.org
13    
14    
15  Requirements  Requirements
16  ------------  ============
17    
18  To use jlscp you need java version 1.5.0 or higher.  To use jlscp you need java version 1.5.0 or higher.
19    
20    To build the library, the documentation or the examples you need
21    JDK version 1.5.0 or higher and the Ant tool (http://ant.apache.org/).
22    
23    
24  Compilation  Compilation
25  -----------  ===========
26    
27    Notice that the package contains both the source and the binary files.
28    So you can skip this section unless you want to rebuild the library or
29    you are using version downloaded from cvs.
30    
31    To build the library, examples or documentation follow the next steps.
32    
33      1. Set the JAVA_HOME environment variable to point to your JDK directory.
34         If the JDK is installed in /opt/jdk1.5.0 directory, this can be done
35         with the following command:
36    
37         export JAVA_HOME=/opt/jdk1.5.0
38    
39         (Windows users must do something like `set JAVA_HOME=c:\jdk1.5.0')
40    
41      2. Choose one or more of the following options.
42    
43         - Building the library (jlscp.jar): `ant build-lib'
44    
45  To compile the library and place the generated class files in the       - Building the documentation: `ant build-doc'
 lib directory, cd to src directory and use the following command:  
46    
47  javac org/linuxsampler/lscp/*.java org/linuxsampler/lscp/event/*.java -d ../lib       - Building the examples: `ant build-examples'
48    
49  To create the JAR file, cd to lib directory and use the following command:       - Building all (library, examples, documentation): `ant build-all'
50    
51  jar -cf jlscp.jar org       Also you may specify more then one target: `ant build-lib build-examples'
52    
53    
54  Installation  Installation
55  ------------  ============
56    
57  To install jlscp as an extension just copy jlscp.jar in the following directory:  To install jlscp as an extension just copy jlscp.jar in the following directory:
58    
# Line 46  option when compiling or running an appl Line 65  option when compiling or running an appl
65    
66    
67  Documentation  Documentation
68  -------------  =============
69    
70  The documentation is located in the doc directory. Also you can look at the  The documentation is located in the doc directory. Also you can look at the
71  examples directory.  examples directory.
72    
73    
74  Running examples  Running examples
75  ----------------  ================
76    
77  To run the examples cd to examples directory  To run the examples `cd' to examples/build directory
78  and use one of the following commands:  and use one of the following commands:
79    
80  java -cp /path/to/jlscp/jlscp.jar:. Poll  java -cp /path/to/jlscp/jlscp.jar:. Poll

Legend:
Removed from v.670  
changed lines
  Added in v.671

  ViewVC Help
Powered by ViewVC