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

Commit

Permalink
README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Pawel Karczewski committed Dec 9, 2020
1 parent f8e6dcb commit dee9d72
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,12 @@
# pmemkv-tools
Optional tools and utilities for pmemkv
# pmemkv-bench
Benchmark for pmemkv and its underlying libraries, based on leveldb's db_bench.

*This is experimental pre-release software and should not be used in
production systems. APIs and file formats may change at any time without
preserving backwards compatibility. All known issues and limitations
are logged as GitHub issues.*

<a name="LD_LIBRARY_PATH"></a>

LD_LIBRARY_PATH
---------------

When running on Fedora, force the library path like this:

```
export LD_LIBRARY_PATH=/usr/local/lib:/usr/local/lib64
```

<a name="benchmarking"></a>

Benchmarking
------------
# Benchmarking

The `pmemkv_bench` utility provides some standard read & write benchmarks. This is
based on the `db_bench` utility included with LevelDB and RocksDB, although the
Expand Down Expand Up @@ -82,8 +68,10 @@ Benchmarking with poolset:
./pmemkv_bench --db=~/pmemkv.poolset
```

## Setting up environment

For more details see [pmemkv/INSTALLING.md](https://github.com/pmem/pmemkv/blob/master/INSTALLING.md).
If pmemkv is installed in some non-standard path, `LD_LIBRARY_PATH` variable should be set

```
export LD_LIBRARY_PATH=</path/to/libpmemkv.so.1>
```

0 comments on commit dee9d72

Please sign in to comment.