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

Commit

Permalink
Merge pull request #87 from lukaszstolarczuk/fix-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
lukaszstolarczuk authored Aug 19, 2020
2 parents 2e48606 + 99edc6c commit 358469a
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
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

0 comments on commit 358469a

Please sign in to comment.