Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davisp committed Mar 22, 2024
1 parent ab970e2 commit a2cb61d
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,26 @@ TileDB - Rust Bindings

Rust bindings for TileDB. Currently covering 0.5% of the API.


Note to macOS Users
Getting Started
---

I have `libtiledb.dylib` installed in `/opt/tiledb/lib` which is not on the
default linker search path and not covered by Cargo's definition of
`DYLD_FALLBACK_LIBRARY_PATH`. Thus, I had to create a `~/.cargo/config.toml`
with these contents:
For the time being, these bindings require that libtiledb be installed into
`/opt/tiledb`. Eventually we'll fix the linking issues to not require this
but for now it was the easiest to get working with Cargo.

```
[build]
rustflags = ["-C", "link-args=-Wl,-rpath,/opt/tiledb/lib"]
```
On macOS and Linux, these quick instructions should be enough to get
`cargo test` running:

I'd really like to figure out how to avoid doing this. I'm guessing I'll
probably have to eventually merge it into a Homebrew linked cask thinger and
then rely on Homebrew search paths? And/or maybe we need to patch TileDB's
CMake scripts for macOS library location?
```sh
$ cd ~/wherever/you/keep/code
$ git clone https://github.com/TileDB-Inc/TileDB
$ cd TileDB
$ mkdir build
$ cd build
$ ../bootstrap --enable=ccache,serialization,debug --prefix=/opt/tiledb
$ make -j$(nproc) && make -C tiledb -j$(nproc) install
$ cd ~/wherever/you/keep/code
$ git clone https://github.com/TileDB-Inc/tiledb-rs
$ cd tiled-rs
$ cargo test
```

0 comments on commit a2cb61d

Please sign in to comment.