Do no make libyaz.so part of dist
[yaz4j-moved-to-github.git] / README
1 yaz4j is a Java wrapper for the ZOOM API of YAZ. This allows developers
2 to write Z39.50 clients in Java.
3
4 yaz4j is distributed under the revised BSD license.
5
6 Copyright (C) 2006-2007, Talis Group Ltd.
7 Copyright (C) 2008-2009, Index Data.
8 See LICENSE for details.
9
10 In order to built yaz4j the Java JDK, ant, YAZ and Swig must be installed.
11 The exact process varies from platform to platform.
12
13 For example, on Ubuntu/Debian the following installs the components:
14   apt-get install sun-java6-jdk ant libyaz3-dev swig
15
16 The compilation is a two-step process. The environment variable JAVA_HOME
17 should point to the Java JDK of your preference. For example,
18   export JAVA_HOME=/usr/lib/jvm/java-6-sun
19
20 Build the shared libary (.so) with:
21   cd libyaz4j
22   ./build.sh
23
24 Rest is built by ant which reads build.xml:
25   cd ..
26   ant
27
28 If you network-connected you should be able to run tests with:
29   ant unit-test