Skip to content

Commit

Permalink
Mention bundle profile
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdickmeiss committed Jan 2, 2021
1 parent 73966f4 commit 94fce06
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,27 @@ compile yaz4j. For example

mvn install

After running `mvn install`, the result is the Java
archive `target/yaz4j-VERSION.jar` and a shared object (JNI) in
directory `target/native`.

As an option, the shared object may be bundled with the JAR file.
Thus, the jar can be distributed as self-contained - provided that the
platform is the same. Enable this by selecting profile `bundle` with
Maven. Use something like:

mvn -Pbundle install

The bundled shared object is stored in directory
`native/${os.name}/${os.arch}` - for example `Linux/amd64/libyaz4j.so`.

## Unix

On Unix, the `yaz-config` utility is used to get compiler flags and
linker libraries for the shared object. Usually it's enough
to install as whole. If there are packages for YAZ already, use
install the "devel" package or "dev" package. Check that `yaz-config`
is in the `PATH`. After running `mvn install`, the result is the Java
archive `target/yaz4j-VERSION.jar` and a shared
object `target/native/libyaz4j.so`.
is in the `PATH`.

## Windows

Expand Down

0 comments on commit 94fce06

Please sign in to comment.