Skip to content
This repository has been archived by the owner on Mar 23, 2023. It is now read-only.

Update README #87

Merged
merged 2 commits into from
Aug 19, 2020
Merged

Update README #87

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c1037d
state explicitly in README - only Java 8 is supported for now
lukaszstolarczuk Aug 11, 2020
99edc6c
extend info for custom libraries paths
lukaszstolarczuk Aug 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Java API is documented with javadocs and can be found as html here:
## Dependencies

* [pmemkv](https://github.com/pmem/pmemkv) - native key/value library
* Java 8 or higher
* Java 8
* [Apache Maven](https://maven.apache.org) - build system
* Used only for development & testing:
* [JUnit](https://junit.org/) - automated test framework
Expand Down Expand Up @@ -50,18 +50,20 @@ mvn install
```

If dependencies (pmemkv, libpmemobj-cpp, pmdk, etc.) are installed in non-standard
location it may be also necessary to set it in LD_LIBRARY_PATH, e.g.:
location(s) it may be also necessary to set up:
**CPLUS_INCLUDE_PATH** and **LIBRARY_PATH** for compiling and linking JNI code (gcc env. variables),
**LD_LIBRARY_PATH** for examples/tests execution.

```sh
LD_LIBRARY_PATH=path_to_your_libs mvn install
CPLUS_INCLUDE_PATH=<path_to_includes> LIBRARY_PATH=<path_to_libs> LD_LIBRARY_PATH=<path_to_libs> mvn install
```

## Testing

This library includes a set of automated tests that exercise all functionality.

```sh
LD_LIBRARY_PATH=path_to_your_libs mvn test
LD_LIBRARY_PATH=<path_to_libs> mvn test
```

## Examples
Expand All @@ -76,7 +78,7 @@ To execute them, run e.g.:
```sh
cd examples
javac -cp ../src/main/target/*.jar StringExample.java
PMEM_IS_PMEM_FORCE=1 java -ea -Xms1G -cp .:`find ../src/main/target -name *.jar` -Djava.library.path=../src/main/cpp/target StringExample
LD_LIBRARY_PATH=<path_to_libs> PMEM_IS_PMEM_FORCE=1 java -ea -Xms1G -cp .:`find ../src/main/target -name *.jar` -Djava.library.path=../src/main/cpp/target StringExample
```

## Documentation
Expand Down