Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/yaz4j
[yaz4j-moved-to-github.git] / README
1 COMPILATION
2
3 Unix
4 ----
5
6 You will need the JDK, Maven, Swig and YAZ development packages.
7 Consult your package manager on how to install those.
8
9 'yaz-config' is assumed to be on the PATH, if it isn't or if local yaz
10 installation is to be used, its location can be forced with:
11
12 mvn -Dyaz.config=/path/to/yaz-config install
13
14
15 Windows
16 -------
17
18 Besides the exact same requirements as in the Unix case, you will need
19 the Windows SDK installed (which in turn requires .NET Framework 4).
20
21 Sensible default is assumed for 'yaz.path' but the 'swig' binary path has
22 hard-coded version number (see yaz4j/pom.xml) which most likely will need to
23 be updated to match your Swig version. Both can be overriden through:
24
25 mvn -Dyaz.path=/path/to/yaz/installation -Dswig=/path/to/swig/binary install
26
27 Use the command prompt provided with the Windows SDK.
28
29
30 RUNNING A TEST PROGRAM
31
32 A trivial test program is included in the yaz4.jar, you can invoke it to check
33 the sanity of your yaz4j compilation/installation. On Windows, the YAZ/bin 
34 directory (default "C:\Porgam Files\YAZ\bin", if you are using YAZ installer) 
35 MUST be on the PATH, otherwise dependent shared libraries will fail to load. 
36 Run:
37
38   java -Djava.library.path=/path/to/yaz4j/dll/or/so/dir -jar any/target/yaz4j.jar
39
40 Where "/path/to/yaz4j/dll/or/so/dir" points to the directory containing the
41 native yaz4j libary (Windows -> yaz4j/win32/target, Unix -> yaz4j/unix/target).
42 You can omit this flag, if your yaz4j.dll/so is already available on the 
43 library path.
44
45
46 LINKS
47
48 The following is most probably already outdated, consult Google.
49
50 * JDK 
51   http://www.oracle.com/technetwork/java/javase/downloads/index.html
52
53 * Maven
54   http://maven.apache.org/download.cgi
55
56 * Swig
57   http://www.swig.org/download.html
58
59 * YAZ
60   http://www.indexdata.com/yaz
61
62 * Windows SDK
63   http://www.microsoft.com/en-us/download/details.aspx?id=8279