Skip to content

Commit

Permalink
refs b1naryth1ef#2 dub should handle windows and posix library linkin…
Browse files Browse the repository at this point in the history
…g, update docs

Docs need to include a few details about building and testing.
  • Loading branch information
truedat101 committed May 25, 2018
1 parent bad9a55 commit ca29c2a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ A straightforward binding to RocksDB v5.0.1 in D-lang.

## Building

You need a valid rocksdb library somewhere your linker can find it.
You need a valid rocksdb library in the root of this project so your linker can find it. It is recommended to use a recent version of rocksdb, tested with

- facebook-rocksdb-v5.12.4

Note: Windows rocksdb is functional, recommendation is to use vcpkg to build rocks first, and copy your rocksdb-shared.dll into the root of this project.

## Testing

> dub test
will launch a benchmark, and should be enough to convine one of the functionality and performance.

## Example

Expand Down
22 changes: 19 additions & 3 deletions dub.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@
"Andrei Zbikowski <[email protected]>"
],
"targetType": "library",
"libraries": ["rocksdb"],
"lflags": ["-lrocksdb"]
}
"libs-windows-x86_64": [
"rocksdb-shared"
],
"libs-windows-x86_mscoff": [
"rocksdb-shared"
],
"libs-posix": [
"rocksdb"
],
"lflags-windows-x86_64": [
"-lrocksdb-shared"
],
"lflags-windows-x86_mscoff": [
"-lrocksdb-shared"
],
"lflags-posix": [
"-lrocksdb"
]
}

0 comments on commit ca29c2a

Please sign in to comment.