Update for ZOOM_scanset_term's size_t parameter
[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.
7 Copyright (C) 2008-2009, Index Data.
8 See LICENSE for details.
9
10 In order to built yaz4j the Java JDK, Maven, 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 maven2 libyaz3-dev swig
15
16 The compilation for native code (JNI) is performed by good old make.
17 Adjust libyaz4j/Makefile as necessary. Tune JAVA_HOME and perhaps path to
18 yaz-config in the Makefile.
19
20 The Maven pom.xml will automatically invoke libyaz4j/Makefile , so
21 this is what it takes:
22   mvn compile
23
24 If you network-connected you should be able to run tests with:
25   mvn test